sentry-ruby-core 4.8.0 → 4.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f675111daf93ba05db7de62dcfa1dd9268f6ba009265de08e0e4f118ffea0c62
-  data.tar.gz: 2ece2ccaf14be6cc5fa762b77a57cd63dcc3fe52a03987c8c4136a43ec62bbd1
+  metadata.gz: '09a04a594b731f8d13770650138f1abd5bce410dad2f4cb4da1a2caa5ef7eba2'
+  data.tar.gz: e87cac23635525aa1b53772e262706a10948b52b634fafeedaf241c8b6d90c9a
 SHA512:
-  metadata.gz: d5d9405c41879a40ba0c0205fa08e38fa5b3ed243276181239be63f0baa0b739b37ac91ecb86abd76768c4c5a706f1f7b7e47d7eadd357f2116ec2ec9bd913d5
-  data.tar.gz: abb46869f2eba00f053096e5568829815b02520db31fe9c98bbfabea40b5dcbe6d438ca97287ca7f9b4fee9a4710b49dec73b9196a3650d3a811184a960a09a7
+  metadata.gz: db6311ce62c548e835cbc49c7616ac244d853c3206599e1b540035b16da97bf05cd52a81602cf30215f15ee3e675d6857cdba628f87fc631e73d63d9523081d5
+  data.tar.gz: ae31de8f2bab17f15f16c8e6fea3fbbc359efc39c5f2ec5afba9fbfccbd4e77c22f051cd2b94278ff9c3ce92289448cccf1af8fc5df5da1fd7f25bb81458ae29

data/.yardopts

@@ -0,0 +1,2 @@
+--exclude lib/sentry/utils/
+--exclude lib/sentry/core_ext

data/Gemfile

@@ -22,3 +22,5 @@ gem "benchmark-ips"
 gem "benchmark_driver"
 gem "benchmark-ipsa"
 gem "benchmark-memory"
+
+gem "yard", "~> 0.9.27"

data/lib/sentry/background_worker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "concurrent/executor/thread_pool_executor"
 require "concurrent/executor/immediate_executor"
 require "concurrent/configuration"
@@ -7,11 +9,15 @@ module Sentry
     include LoggingHelper
 
     attr_reader :max_queue, :number_of_threads, :logger
+    attr_accessor :shutdown_timeout
 
     def initialize(configuration)
       @max_queue = 30
+      @shutdown_timeout = 1
       @number_of_threads = configuration.background_worker_threads
       @logger = configuration.logger
+      @debug = configuration.debug
+      @shutdown_callback = nil
 
       @executor =
         if configuration.async
@@ -23,19 +29,41 @@ module Sentry
         else
           log_debug("initialized a background worker with #{@number_of_threads} threads")
 
-          Concurrent::ThreadPoolExecutor.new(
+          executor = Concurrent::ThreadPoolExecutor.new(
             min_threads: 0,
             max_threads: @number_of_threads,
             max_queue: @max_queue,
             fallback_policy: :discard
           )
+
+          @shutdown_callback = proc do
+            executor.shutdown
+            executor.wait_for_termination(@shutdown_timeout)
+          end
+
+          executor
         end
     end
 
+    # if you want to monkey-patch this method, please override `_perform` instead
     def perform(&block)
       @executor.post do
-        block.call
+        begin
+          _perform(&block)
+        rescue Exception => e
+          log_error("exception happened in background worker", e, debug: @debug)
+        end
       end
     end
+
+    def shutdown
+      @shutdown_callback&.call
+    end
+
+    private
+
+    def _perform(&block)
+      block.call
+    end
   end
 end

data/lib/sentry/backtrace.rb

@@ -4,6 +4,7 @@
 
 module Sentry
   # Front end to parsing the backtrace for each notice
+  # @api private
   class Backtrace
     # Handles backtrace parsing line by line
     class Line

data/lib/sentry/breadcrumb/sentry_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 
 module Sentry

data/lib/sentry/breadcrumb.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   class Breadcrumb
     DATA_SERIALIZATION_ERROR_MESSAGE = "[data were removed due to serialization issues]"

data/lib/sentry/breadcrumb_buffer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "sentry/breadcrumb"
 
 module Sentry

data/lib/sentry/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "sentry/transport"
 
 module Sentry

data/lib/sentry/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "concurrent/utility/processor_counter"
 
 require "sentry/utils/exception_cause_chain"
@@ -15,10 +17,15 @@ module Sentry
     # Directories to be recognized as part of your app. e.g. if you
     # have an `engines` dir at the root of your project, you may want
     # to set this to something like /(app|config|engines|lib)/
+    #
+    # @return [Regexp, nil]
     attr_accessor :app_dirs_pattern
 
     # Provide an object that responds to `call` to send events asynchronously.
     # E.g.: lambda { |event| Thread.new { Sentry.send_event(event) } }
+    #
+    # @deprecated It will be removed in the next major release. Please read https://github.com/getsentry/sentry-ruby/issues/1522 for more information
+    # @return [Proc, nil]
     attr_reader :async
 
     # to send events in a non-blocking way, sentry-ruby has its own background worker
@@ -28,74 +35,94 @@ module Sentry
     #
     # if you want to send events synchronously, set the value to 0
     # E.g.: config.background_worker_threads = 0
+    # @return [Integer]
     attr_accessor :background_worker_threads
 
     # a proc/lambda that takes an array of stack traces
     # it'll be used to silence (reduce) backtrace of the exception
     #
-    # for example:
-    #
-    # ```ruby
-    # Sentry.configuration.backtrace_cleanup_callback = lambda do |backtrace|
-    #   Rails.backtrace_cleaner.clean(backtrace)
-    # end
-    # ```
+    # @example
+    #   config.backtrace_cleanup_callback = lambda do |backtrace|
+    #     Rails.backtrace_cleaner.clean(backtrace)
+    #   end
     #
+    # @return [Proc]
     attr_accessor :backtrace_cleanup_callback
 
     # Optional Proc, called before adding the breadcrumb to the current scope
-    # E.g.: lambda { |breadcrumb, hint| breadcrumb }
-    # E.g.: lambda { |breadcrumb, hint| nil }
-    # E.g.: lambda { |breadcrumb, hint|
-    #   breadcrumb.message = 'a'
-    #   breadcrumb
-    # }
+    # @example
+    #   config.before = lambda do |breadcrumb, hint|
+    #     breadcrumb.message = 'a'
+    #     breadcrumb
+    #   end
+    # @return [Proc]
     attr_reader :before_breadcrumb
 
-    # Optional Proc, called before sending an event to the server/
-    # E.g.: lambda { |event, hint| event }
-    # E.g.: lambda { |event, hint| nil }
-    # E.g.: lambda { |event, hint|
-    #   event[:message] = 'a'
-    #   event
-    # }
+    # Optional Proc, called before sending an event to the server
+    # @example
+    #   config.before_send = lambda do |event, hint|
+    #     # skip ZeroDivisionError exceptions
+    #     # note: hint[:exception] would be a String if you use async callback
+    #     if hint[:exception].is_a?(ZeroDivisionError)
+    #       nil
+    #     else
+    #       event
+    #     end
+    #   end
+    # @return [Proc]
     attr_reader :before_send
 
     # An array of breadcrumbs loggers to be used. Available options are:
     # - :sentry_logger
+    # - :http_logger
+    #
+    # And if you also use sentry-rails:
     # - :active_support_logger
+    # - :monotonic_active_support_logger
+    #
+    # @return [Array<Symbol>]
     attr_reader :breadcrumbs_logger
 
     # Whether to capture local variables from the raised exception's frame. Default is false.
+    # @return [Boolean]
     attr_accessor :capture_exception_frame_locals
 
     # Max number of breadcrumbs a breadcrumb buffer can hold
+    # @return [Integer]
     attr_accessor :max_breadcrumbs
 
     # Number of lines of code context to capture, or nil for none
+    # @return [Integer, nil]
     attr_accessor :context_lines
 
     # RACK_ENV by default.
+    # @return [String]
     attr_reader :environment
 
     # Whether the SDK should run in the debugging mode. Default is false.
     # If set to true, SDK errors will be logged with backtrace
+    # @return [Boolean]
     attr_accessor :debug
 
     # the dsn value, whether it's set via `config.dsn=` or `ENV["SENTRY_DSN"]`
+    # @return [String]
     attr_reader :dsn
 
     # Whitelist of enabled_environments that will send notifications to Sentry. Array of Strings.
+    # @return [Array<String>]
     attr_accessor :enabled_environments
 
     # Logger 'progname's to exclude from breadcrumbs
+    # @return [Array<String>]
     attr_accessor :exclude_loggers
 
     # Array of exception classes that should never be sent. See IGNORE_DEFAULT.
     # You should probably append to this rather than overwrite it.
+    # @return [Array<String>]
     attr_accessor :excluded_exceptions
 
     # Boolean to check nested exceptions when deciding if to exclude. Defaults to true
+    # @return [Boolean]
     attr_accessor :inspect_exception_causes_for_exclusion
     alias inspect_exception_causes_for_exclusion? inspect_exception_causes_for_exclusion
 
@@ -106,65 +133,80 @@ module Sentry
 
     # Logger used by Sentry. In Rails, this is the Rails logger, otherwise
     # Sentry provides its own Sentry::Logger.
+    # @return [Logger]
     attr_accessor :logger
 
     # Project directory root for in_app detection. Could be Rails root, etc.
     # Set automatically for Rails.
+    # @return [String]
     attr_accessor :project_root
 
     # Insert sentry-trace to outgoing requests' headers
+    # @return [Boolean]
     attr_accessor :propagate_traces
 
     # Array of rack env parameters to be included in the event sent to sentry.
+    # @return [Array<String>]
     attr_accessor :rack_env_whitelist
 
     # Release tag to be passed with every event sent to Sentry.
     # We automatically try to set this to a git SHA or Capistrano release.
+    # @return [String]
     attr_accessor :release
 
     # The sampling factor to apply to events. A value of 0.0 will not send
     # any events, and a value of 1.0 will send 100% of events.
+    # @return [Float]
     attr_accessor :sample_rate
 
     # Include module versions in reports - boolean.
+    # @return [Boolean]
     attr_accessor :send_modules
 
     # When send_default_pii's value is false (default), sensitive information like
     # - user ip
     # - user cookie
     # - request body
+    # - query string
     # will not be sent to Sentry.
+    # @return [Boolean]
     attr_accessor :send_default_pii
 
     # Allow to skip Sentry emails within rake tasks
+    # @return [Boolean]
     attr_accessor :skip_rake_integration
 
     # IP ranges for trusted proxies that will be skipped when calculating IP address.
     attr_accessor :trusted_proxies
 
+    # @return [String]
     attr_accessor :server_name
 
     # Return a Transport::Configuration object for transport-related configurations.
+    # @return [Transport]
     attr_reader :transport
 
     # Take a float between 0.0 and 1.0 as the sample rate for tracing events (transactions).
+    # @return [Float]
     attr_accessor :traces_sample_rate
 
     # Take a Proc that controls the sample rate for every tracing event, e.g.
-    # ```
-    # lambda do |tracing_context|
-    #   # tracing_context[:transaction_context] contains the information about the transaction
-    #   # tracing_context[:parent_sampled] contains the transaction's parent's sample decision
-    #   true # return value can be a boolean or a float between 0.0 and 1.0
-    # end
-    # ```
+    # @example
+    #   config.traces_sampler =  lambda do |tracing_context|
+    #     # tracing_context[:transaction_context] contains the information about the transaction
+    #     # tracing_context[:parent_sampled] contains the transaction's parent's sample decision
+    #     true # return value can be a boolean or a float between 0.0 and 1.0
+    #   end
+    # @return [Proc]
     attr_accessor :traces_sampler
 
     # Send diagnostic client reports about dropped events, true by default
     # tries to attach to an existing envelope max once every 30s
+    # @return [Boolean]
     attr_accessor :send_client_reports
 
     # these are not config options
+    # @!visibility private
     attr_reader :errors, :gem_specs
 
     # Most of these errors generate 4XX responses. In general, Sentry clients
@@ -285,11 +327,6 @@ module Sentry
       Random.rand < sample_rate
     end
 
-    def error_messages
-      @errors = [@errors[0]] + @errors[1..-1].map(&:downcase) # fix case of all but first
-      @errors.join(", ")
-    end
-
     def exception_class_allowed?(exc)
       if exc.is_a?(Sentry::Error)
         # Try to prevent error reporting loops
@@ -311,6 +348,17 @@ module Sentry
       !!((@traces_sample_rate && @traces_sample_rate >= 0.0 && @traces_sample_rate <= 1.0) || @traces_sampler) && sending_allowed?
     end
 
+    # @return [String, nil]
+    def csp_report_uri
+      if dsn && dsn.valid?
+        uri = dsn.csp_report_uri
+        uri += "&sentry_release=#{CGI.escape(release)}" if release && !release.empty?
+        uri += "&sentry_environment=#{CGI.escape(environment)}" if environment && !environment.empty?
+        uri
+      end
+    end
+
+    # @api private
     def stacktrace_builder
       @stacktrace_builder ||= StacktraceBuilder.new(
         project_root: @project_root.to_s,
@@ -321,6 +369,7 @@ module Sentry
       )
     end
 
+    # @api private
     def detect_release
       return unless sending_allowed?
 
@@ -333,13 +382,10 @@ module Sentry
       log_error("Error detecting release", e, debug: debug)
     end
 
-    def csp_report_uri
-      if dsn && dsn.valid?
-        uri = dsn.csp_report_uri
-        uri += "&sentry_release=#{CGI.escape(release)}" if release && !release.empty?
-        uri += "&sentry_environment=#{CGI.escape(environment)}" if environment && !environment.empty?
-        uri
-      end
+    # @api private
+    def error_messages
+      @errors = [@errors[0]] + @errors[1..-1].map(&:downcase) # fix case of all but first
+      @errors.join(", ")
     end
 
     private

data/lib/sentry/core_ext/object/deep_dup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 return if Object.method_defined?(:deep_dup)
 
 require 'sentry/core_ext/object/duplicable'

data/lib/sentry/core_ext/object/duplicable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 return if Object.method_defined?(:duplicable?)
 
 #########################################

data/lib/sentry/dsn.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "uri"
 
 module Sentry

data/lib/sentry/envelope.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Sentry
+  # @api private
+  class Envelope
+    def initialize(headers)
+      @headers = headers
+      @items = []
+    end
+
+    def add_item(headers, payload)
+      @items << [headers, payload]
+    end
+
+    def to_s
+      payload = @items.map do |item_headers, item_payload|
+        <<~ENVELOPE
+          #{JSON.generate(item_headers)}
+          #{JSON.generate(item_payload)}
+        ENVELOPE
+      end.join("\n")
+
+      "#{JSON.generate(@headers)}\n#{payload}"
+    end
+  end
+end

data/lib/sentry/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   class Error < StandardError
   end

data/lib/sentry/hub.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "sentry/scope"
 require "sentry/client"
 

data/lib/sentry/integrable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   module Integrable
     def register_integration(name:, version:)

data/lib/sentry/interface.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   class Interface
     def self.inherited(klass)

data/lib/sentry/interfaces/exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   class ExceptionInterface < Interface
     def initialize(values:)

data/lib/sentry/interfaces/single_exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "sentry/utils/exception_cause_chain"
 
 module Sentry

data/lib/sentry/interfaces/stacktrace.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   class StacktraceInterface
     attr_reader :frames

data/lib/sentry/interfaces/stacktrace_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   class StacktraceBuilder
     attr_reader :project_root, :app_dirs_pattern, :linecache, :context_lines, :backtrace_cleanup_callback

data/lib/sentry/interfaces/threads.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   class ThreadsInterface
     def initialize(crashed: false, stacktrace: nil)

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

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Sentry
+  # @api private
   class ReleaseDetector
     class << self
       def detect_release(project_root:, running_on_heroku:)

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(

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,5 +1,8 @@
+# frozen_string_literal: true
+
 require "json"
 require "base64"
+require "sentry/envelope"
 
 module Sentry
   class Transport
@@ -103,31 +106,29 @@ module Sentry
     def encode(event)
       # Convert 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_header = {
-        event_id: event_id,
-        dsn: @dsn.to_s,
-        sdk: Sentry.sdk_meta,
-        sent_at: Sentry.utc_now.iso8601
-      }
-
-      event_header = { type: item_type, content_type: 'application/json' }
+      envelope = Envelope.new(
+        {
+          event_id: event_id,
+          dsn: @dsn.to_s,
+          sdk: Sentry.sdk_meta,
+          sent_at: Sentry.utc_now.iso8601
+        }
+      )
 
-      envelope = <<~ENVELOPE
-        #{JSON.generate(envelope_header)}
-        #{JSON.generate(event_header)}
-        #{JSON.generate(event_payload)}
-      ENVELOPE
+      envelope.add_item(
+        { type: item_type, content_type: 'application/json' },
+        event_payload
+      )
 
-      client_report = fetch_pending_client_report
-      envelope << client_report if client_report
+      client_report_headers, client_report_payload = fetch_pending_client_report
+      envelope.add_item(client_report_headers, client_report_payload) if client_report_headers
 
       log_info("Sending envelope [#{item_type}] #{event_id} to Sentry")
 
-      envelope
+      envelope.to_s
     end
 
     def record_lost_event(reason, item_type)
@@ -159,21 +160,15 @@ module Sentry
       end
 
       item_header = { type: 'client_report' }
-
       item_payload = {
         timestamp: Sentry.utc_now.iso8601,
         discarded_events: discarded_events_hash
       }
 
-      client_report_item = <<~CLIENT_REPORT_ITEM
-        #{JSON.generate(item_header)}
-        #{JSON.generate(item_payload)}
-      CLIENT_REPORT_ITEM
-
       @discarded_events = Hash.new(0)
       @last_client_report_sent = Time.now
 
-      client_report_item
+      [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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   module CustomInspection
     def inspect

data/lib/sentry/utils/exception_cause_chain.rb

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

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.8.0"
+  VERSION = "4.8.2"
 end

data/lib/sentry-ruby.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "English"
 require "forwardable"
 require "time"
@@ -37,6 +39,7 @@ module Sentry
   THREAD_LOCAL = :sentry_hub
 
   class << self
+    # @!visibility private
     def exception_locals_tp
       @exception_locals_tp ||= TracePoint.new(:raise) do |tp|
         exception = tp.raised_exception
@@ -53,46 +56,60 @@ module Sentry
       end
     end
 
+    # @!attribute [rw] background_worker
+    #   @return [BackgroundWorker]
     attr_accessor :background_worker
 
     ##### Patch Registration #####
-    #
+
+    # @!visibility private
     def register_patch(&block)
       registered_patches << block
     end
 
+    # @!visibility private
     def apply_patches(config)
       registered_patches.each do |patch|
         patch.call(config)
       end
     end
 
+    # @!visibility private
     def registered_patches
       @registered_patches ||= []
     end
 
     ##### Integrations #####
-    #
+
     # Returns a hash that contains all the integrations that have been registered to the main SDK.
+    #
+    # @return [Hash{String=>Hash}]
     def integrations
       @integrations ||= {}
     end
 
     # Registers the SDK integration with its name and version.
+    #
+    # @param name [String] name of the integration
+    # @param version [String] version of the integration
     def register_integration(name, version)
       meta = { name: "sentry.ruby.#{name}", version: version }.freeze
       integrations[name.to_s] = meta
     end
 
     ##### Method Delegation #####
-    #
+
     extend Forwardable
 
     def_delegators :get_current_client, :configuration, :send_event
     def_delegators :get_current_scope, :set_tags, :set_extras, :set_user, :set_context
 
     ##### Main APIs #####
+
+    # Initializes the SDK with given configuration.
     #
+    # @yieldparam config [Configuration]
+    # @return [void]
     def init(&block)
       config = Configuration.new
       yield(config) if block_given?
@@ -108,26 +125,42 @@ module Sentry
       if config.capture_exception_frame_locals
         exception_locals_tp.enable
       end
+
+      at_exit do
+        @background_worker.shutdown
+      end
+    end
+
+    # Returns true if the SDK is initialized.
+    #
+    # @return [Boolean]
+    def initialized?
+      !!@main_hub
     end
 
     # Returns an uri for security policy reporting that's generated from the given DSN
     # (To learn more about security policy reporting: https://docs.sentry.io/product/security-policy-reporting/)
     #
     # It returns nil if
+    # - The SDK is not initialized yet.
+    # - The DSN is not provided or is invalid.
     #
-    # 1. The SDK is not initialized yet.
-    # 2. The DSN is not provided or is invalid.
+    # @return [String, nil]
     def csp_report_uri
       return unless initialized?
       configuration.csp_report_uri
     end
 
     # Returns the main thread's active hub.
+    #
+    # @return [Hub]
     def get_main_hub
       @main_hub
     end
 
     # Takes an instance of Sentry::Breadcrumb and stores it to the current active scope.
+    #
+    # @return [Breadcrumb, nil]
     def add_breadcrumb(breadcrumb, **options)
       get_current_hub&.add_breadcrumb(breadcrumb, **options)
     end
@@ -135,6 +168,8 @@ module Sentry
     # Returns the current active hub.
     # If the current thread doesn't have an active hub, it will clone the main thread's active hub,
     # stores it in the current thread, and then returns it.
+    #
+    # @return [Hub]
     def get_current_hub
       # we need to assign a hub to the current thread if it doesn't have one yet
       #
@@ -145,85 +180,105 @@ module Sentry
     end
 
     # Returns the current active client.
+    # @return [Client, nil]
     def get_current_client
       get_current_hub&.current_client
     end
 
     # Returns the current active scope.
+    #
+    # @return [Scope, nil]
     def get_current_scope
       get_current_hub&.current_scope
     end
 
     # Clones the main thread's active hub and stores it to the current thread.
+    #
+    # @return [void]
     def clone_hub_to_current_thread
       Thread.current.thread_variable_set(THREAD_LOCAL, get_main_hub.clone)
     end
 
     # Takes a block and yields the current active scope.
     #
-    # ```ruby
-    # Sentry.configure_scope do |scope|
-    #   scope.set_tags(foo: "bar")
-    # end
+    # @example
+    #   Sentry.configure_scope do |scope|
+    #     scope.set_tags(foo: "bar")
+    #   end
     #
-    # Sentry.capture_message("test message") # this event will have tags { foo: "bar" }
-    # ```
+    #   Sentry.capture_message("test message") # this event will have tags { foo: "bar" }
     #
+    # @yieldparam scope [Scope]
+    # @return [void]
     def configure_scope(&block)
       get_current_hub&.configure_scope(&block)
     end
 
     # Takes a block and yields a temporary scope.
     # The temporary scope will inherit all the attributes from the current active scope and replace it to be the active
-    # scope inside the block. For example:
+    # scope inside the block.
     #
-    # ```ruby
-    # Sentry.configure_scope do |scope|
-    #   scope.set_tags(foo: "bar")
-    # end
+    # @example
+    #   Sentry.configure_scope do |scope|
+    #     scope.set_tags(foo: "bar")
+    #   end
     #
-    # Sentry.capture_message("test message") # this event will have tags { foo: "bar" }
+    #   Sentry.capture_message("test message") # this event will have tags { foo: "bar" }
     #
-    # Sentry.with_scope do |temp_scope|
-    #   temp_scope.set_tags(foo: "baz")
-    #   Sentry.capture_message("test message 2") # this event will have tags { foo: "baz" }
-    # end
+    #   Sentry.with_scope do |temp_scope|
+    #     temp_scope.set_tags(foo: "baz")
+    #     Sentry.capture_message("test message 2") # this event will have tags { foo: "baz" }
+    #   end
     #
-    # Sentry.capture_message("test message 3") # this event will have tags { foo: "bar" }
-    # ```
+    #   Sentry.capture_message("test message 3") # this event will have tags { foo: "bar" }
     #
+    # @yieldparam scope [Scope]
+    # @return [void]
     def with_scope(&block)
       get_current_hub&.with_scope(&block)
     end
 
     # Takes an exception and reports it to Sentry via the currently active hub.
+    #
+    # @yieldparam scope [Scope]
+    # @return [Event, nil]
     def capture_exception(exception, **options, &block)
       get_current_hub&.capture_exception(exception, **options, &block)
     end
 
     # Takes a message string and reports it to Sentry via the currently active hub.
+    #
+    # @yieldparam scope [Scope]
+    # @return [Event, nil]
     def capture_message(message, **options, &block)
       get_current_hub&.capture_message(message, **options, &block)
     end
 
     # Takes an instance of Sentry::Event and dispatches it to the currently active hub.
+    #
+    # @return [Event, nil]
     def capture_event(event)
       get_current_hub&.capture_event(event)
     end
 
     # Takes or initializes a new Sentry::Transaction and makes a sampling decision for it.
+    #
+    # @return [Transaction, nil]
     def start_transaction(**options)
       get_current_hub&.start_transaction(**options)
     end
 
     # Returns the id of the lastly reported Sentry::Event.
+    #
+    # @return [String, nil]
     def last_event_id
       get_current_hub&.last_event_id
     end
 
 
     ##### Helpers #####
-    #
+
+    # @!visibility private
     def sys_command(command)
       result = `#{command} 2>&1` rescue nil
       return if result.nil? || result.empty? || ($CHILD_STATUS && $CHILD_STATUS.exitstatus != 0)
@@ -231,18 +286,17 @@ module Sentry
       result.strip
     end
 
-    def initialized?
-      !!@main_hub
-    end
-
+    # @!visibility private
     def logger
       configuration.logger
     end
 
+    # @!visibility private
     def sdk_meta
       META
     end
 
+    # @!visibility private
     def utc_now
       Time.now.utc
     end

data/sentry-ruby.gemspec

@@ -18,6 +18,6 @@ Gem::Specification.new do |spec|
   spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
 
   spec.add_dependency "sentry-ruby-core", Sentry::VERSION
-  spec.add_dependency "faraday", ">= 1.0"
+  spec.add_dependency "faraday", "~> 1.0"
   spec.add_dependency "concurrent-ruby", '~> 1.0', '>= 1.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby-core
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.8.2
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-11 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -48,6 +48,7 @@ extra_rdoc_files:
 files:
 - ".gitignore"
 - ".rspec"
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -68,6 +69,7 @@ files:
 - lib/sentry/core_ext/object/deep_dup.rb
 - lib/sentry/core_ext/object/duplicable.rb
 - lib/sentry/dsn.rb
+- lib/sentry/envelope.rb
 - lib/sentry/event.rb
 - lib/sentry/exceptions.rb
 - lib/sentry/hub.rb