sentry-ruby-core 4.8.0 → 4.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f675111daf93ba05db7de62dcfa1dd9268f6ba009265de08e0e4f118ffea0c62
-  data.tar.gz: 2ece2ccaf14be6cc5fa762b77a57cd63dcc3fe52a03987c8c4136a43ec62bbd1
+  metadata.gz: c0d62d3133d461116b39ce7e822a3cc523c378417eafade8b3a904f76bce5289
+  data.tar.gz: 4ae280d6e7d88107e7f34f0794d266182d1c801407373023293c38db038aae50
 SHA512:
-  metadata.gz: d5d9405c41879a40ba0c0205fa08e38fa5b3ed243276181239be63f0baa0b739b37ac91ecb86abd76768c4c5a706f1f7b7e47d7eadd357f2116ec2ec9bd913d5
-  data.tar.gz: abb46869f2eba00f053096e5568829815b02520db31fe9c98bbfabea40b5dcbe6d438ca97287ca7f9b4fee9a4710b49dec73b9196a3650d3a811184a960a09a7
+  metadata.gz: 8027f22238a8012bb1aca95d528cb479e287a5b6b17269c9789056d6959f33cab558fac3166147b82b2bda7ee6ad87f4d484ad83634d41804bf198ea7fddd7b2
+  data.tar.gz: ea6681465bf4f538139b0ba6057ea34dec7cb848e77be48ca65c5d7ee5080c492f324dda7903f40d1db275d4bea4f3887048ebf144d7748d02be35314e5fb977

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/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"

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,25 @@
+# frozen_string_literal: true
+
+module Sentry
+  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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   class LineCache
     def initialize

data/lib/sentry/net/http.rb

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

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,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rake"
 require "rake/task"
 
@@ -5,7 +7,7 @@ module Sentry
   module Rake
     module Application
       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)
@@ -19,9 +21,7 @@ module Sentry
       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

data/lib/sentry/release_detector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   class ReleaseDetector
     class << self

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.1"
 end

data/lib/sentry-ruby.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "English"
 require "forwardable"
 require "time"
@@ -108,6 +110,10 @@ module Sentry
       if config.capture_exception_frame_locals
         exception_locals_tp.enable
       end
+
+      at_exit do
+        @background_worker.shutdown
+      end
     end
 
     # Returns an uri for security policy reporting that's generated from the given DSN

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.1
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-11 00:00:00.000000000 Z
+date: 2021-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -68,6 +68,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