sentry-ruby-core 5.3.0 → 5.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03d233c6e1bd55ddc4044c7a23b6bc74047eec17a8c16d5f33f768065641259c
-  data.tar.gz: bec07f880bff192b6ef71aaefdf9dc9ff2ff072a539f94ed5c4fd0398ad1146a
+  metadata.gz: 3e7ba4b82e18f29dcb0d2949098a489f93ffec19ca2888ca8f096644d182480b
+  data.tar.gz: b27555038074ec03421cc287dbecf2fa7e85642c4bffaa71bb770232dc6eb4d1
 SHA512:
-  metadata.gz: c3d90a9b888db8a396e260dccf5df3a38d4f153c9bc2b31b92fc206009553fec2d3d0fe47bb1a871b001372fcba8013fee4e16b60405588db4ce3984f56d675e
-  data.tar.gz: 2ae1db7dee78487fec06b1cb1c6fb2dfa77852ae20b0c28b6c2f0e0b964f728fdea40a8261495439ef6e193182a0f7dc3196dc1bd75368abcf2d78852310361a
+  metadata.gz: 9f0101061e4e980b7bdd6c849257aed2bdf3a8f698af8b7a6b7eb1bd2b4b4e00d391acf6c03c152668fa134e5b4c630518b9325fb19c527c03827cb864557feb
+  data.tar.gz: ef0594cbf709b46819b970debebec8f2a5be3f49aa483ea15963640af3ab84ea9c180ffbf6138675d8354d840106fca5e4e178d1f40e13e22b5ff57b60402e83

data/Gemfile

@@ -1,7 +1,6 @@
 source "https://rubygems.org"
 git_source(:github) { |name| "https://github.com/#{name}.git" }
 
-gem "sentry-ruby-core", path: "./"
 gem "sentry-ruby", path: "./"
 
 gem "rack" unless ENV["WITHOUT_RACK"] == "1"

data/README.md

@@ -1,8 +1,11 @@
 <p align="center">
-  <a href="https://sentry.io" target="_blank" align="center">
-    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  <a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
+    <picture>
+      <source srcset="https://sentry-brand.storage.googleapis.com/sentry-logo-white.png" media="(prefers-color-scheme: dark)" />
+      <source srcset="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" />
+      <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" alt="Sentry" width="280">
+    </picture>
   </a>
-  <br />
 </p>
 
 _Bad software is everywhere, and we're tired of it. Sentry is on a mission to help developers write better software faster, so we can get back to enjoying technology. If you want to join us [<kbd>**Check out our open positions**</kbd>](https://sentry.io/careers/)_
@@ -52,13 +55,11 @@ gem "sentry-resque"
 
 ### Configuration
 
-You can use `Sentry.init` to initialize and configure your SDK:
-
+You need to use Sentry.init to initialize and configure your SDK:
 ```ruby
 Sentry.init do |config|
   config.dsn = "MY_DSN"
 end
-
 ```
 
 To learn more about available configuration options, please visit the [official documentation](https://docs.sentry.io/platforms/ruby/configuration/options/).

data/lib/sentry/client.rb

@@ -167,7 +167,14 @@ module Sentry
     def dispatch_async_event(async_block, event, hint)
       # We have to convert to a JSON-like hash, because background job
       # processors (esp ActiveJob) may not like weird types in the event hash
-      event_hash = event.to_json_compatible
+
+      event_hash =
+        begin
+          event.to_json_compatible
+        rescue => e
+          log_error("Converting #{event.type} (#{event.event_id}) to JSON compatible hash failed", e, debug: configuration.debug)
+          return
+        end
 
       if async_block.arity == 2
         hint = JSON.parse(JSON.generate(hint))

data/lib/sentry/configuration.rb

@@ -290,6 +290,16 @@ module Sentry
     def async=(value)
       check_callable!("async", value)
 
+      log_warn <<~MSG
+
+        sentry-ruby now sends events asynchronously by default with its background worker (supported since 4.1.0).
+        The `config.async` callback has become redundant while continuing to cause issues.
+        (The problems of `async` are detailed in https://github.com/getsentry/sentry-ruby/issues/1522)
+
+        Therefore, we encourage you to remove it and let the background worker take care of async job sending.
+      It's deprecation is planned in the next major release (6.0), which is scheduled around the 3rd quarter of 2022.
+      MSG
+
       @async = value
     end
 

data/lib/sentry/envelope.rb

@@ -4,6 +4,9 @@ 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)
@@ -21,6 +24,54 @@ module Sentry
           #{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

data/lib/sentry/event.rb

@@ -26,7 +26,6 @@ module Sentry
     WRITER_ATTRIBUTES = SERIALIZEABLE_ATTRIBUTES - %i(type timestamp level)
 
     MAX_MESSAGE_SIZE_IN_BYTES = 1024 * 8
-    MAX_SERIALIZED_PAYLOAD_SIZE = 1024 * 200
 
     SKIP_INSPECTION_ATTRIBUTES = [:@modules, :@stacktrace_builder, :@send_default_pii, :@trusted_proxies, :@rack_env_whitelist]
 

data/lib/sentry/interfaces/exception.rb

@@ -3,6 +3,9 @@ require "set"
 
 module Sentry
   class ExceptionInterface < Interface
+    # @return [<Array[SingleExceptionInterface]>]
+    attr_reader :values
+
     # @param exceptions [Array<SingleExceptionInterface>]
     def initialize(exceptions:)
       @values = exceptions

data/lib/sentry/rack/capture_exceptions.rb

@@ -3,6 +3,8 @@
 module Sentry
   module Rack
     class CaptureExceptions
+      ERROR_EVENT_ID_KEY = "sentry.error_event_id"
+
       def initialize(app)
         @app = app
       end
@@ -28,13 +30,13 @@ module Sentry
               finish_transaction(transaction, 500)
               raise # Don't capture Sentry errors
             rescue Exception => e
-              capture_exception(e)
+              capture_exception(e, env)
               finish_transaction(transaction, 500)
               raise
             end
 
             exception = collect_exception(env)
-            capture_exception(exception) if exception
+            capture_exception(exception, env) if exception
 
             finish_transaction(transaction, response[0])
 
@@ -53,8 +55,10 @@ module Sentry
         "rack.request".freeze
       end
 
-      def capture_exception(exception)
-        Sentry.capture_exception(exception)
+      def capture_exception(exception, env)
+        Sentry.capture_exception(exception).tap do |event|
+          env[ERROR_EVENT_ID_KEY] = event.event_id if event
+        end
       end
 
       def start_transaction(env, scope)

data/lib/sentry/session_flusher.rb

@@ -8,6 +8,7 @@ module Sentry
 
     def initialize(configuration, client)
       @thread = nil
+      @exited = false
       @client = client
       @pending_aggregates = {}
       @release = configuration.release
@@ -29,9 +30,16 @@ module Sentry
     end
 
     def add_session(session)
+      return if @exited
       return unless @release
 
-      ensure_thread
+      begin
+        ensure_thread
+      rescue ThreadError
+        log_debug("Session flusher thread creation failed")
+        @exited = true
+        return
+      end
 
       return unless Session::AGGREGATE_STATUSES.include?(session.status)
       @pending_aggregates[session.aggregation_key] ||= init_aggregates(session.aggregation_key)
@@ -40,6 +48,8 @@ module Sentry
 
     def kill
       log_debug("Killing session flusher")
+
+      @exited = true
       @thread&.kill
     end
 

data/lib/sentry/test_helper.rb

@@ -0,0 +1,76 @@
+module Sentry
+  module TestHelper
+    DUMMY_DSN = 'http://12345:67890@sentry.localdomain/sentry/42'
+
+    # Alters the existing SDK configuration with test-suitable options. Mainly:
+    # - Sets a dummy DSN instead of `nil` or an actual DSN.
+    # - Sets the transport to DummyTransport, which allows easy access to the captured events.
+    # - Disables background worker.
+    # - Makes sure the SDK is enabled under the current environment ("test" in most cases).
+    #
+    # It should be called **before** every test case.
+    #
+    # @yieldparam config [Configuration]
+    # @return [void]
+    def setup_sentry_test(&block)
+      raise "please make sure the SDK is initialized for testing" unless Sentry.initialized?
+      copied_config = Sentry.configuration.dup
+      # configure dummy DSN, so the events will not be sent to the actual service
+      copied_config.dsn = DUMMY_DSN
+      # set transport to DummyTransport, so we can easily intercept the captured events
+      copied_config.transport.transport_class = Sentry::DummyTransport
+      # make sure SDK allows sending under the current environment
+      copied_config.enabled_environments << copied_config.environment unless copied_config.enabled_environments.include?(copied_config.environment)
+      # disble async event sending
+      copied_config.background_worker_threads = 0
+
+      # user can overwrite some of the configs, with a few exceptions like:
+      # - capture_exception_frame_locals
+      # - auto_session_tracking
+      block&.call(copied_config)
+
+      test_client = Sentry::Client.new(copied_config)
+      Sentry.get_current_hub.bind_client(test_client)
+    end
+
+    # Clears all stored events and envelopes.
+    # It should be called **after** every test case.
+    # @return [void]
+    def teardown_sentry_test
+      return unless Sentry.initialized?
+
+      sentry_transport.events = []
+      sentry_transport.envelopes = []
+    end
+
+    # @return [Transport]
+    def sentry_transport
+      Sentry.get_current_client.transport
+    end
+
+    # Returns the captured event objects.
+    # @return [Array<Event>]
+    def sentry_events
+      sentry_transport.events
+    end
+
+    # Returns the captured envelope objects.
+    # @return [Array<Envelope>]
+    def sentry_envelopes
+      sentry_transport.envelopes
+    end
+
+    # Returns the last captured event object.
+    # @return [Event, nil]
+    def last_sentry_event
+      sentry_events.last
+    end
+
+    # Extracts SDK's internal exception container (not actual exception objects) from an given event.
+    # @return [Array<Sentry::SingleExceptionInterface>]
+    def extract_sentry_exceptions(event)
+      event&.exception&.values || []
+    end
+  end
+end
+

data/lib/sentry/transport.rb

@@ -70,24 +70,10 @@ module Sentry
       serialized_results = []
 
       envelope.items.each do |item|
-        result = item.to_s
+        result, oversized = item.serialize
 
-        if result.bytesize > Event::MAX_SERIALIZED_PAYLOAD_SIZE
-          if item.payload.key?(:breadcrumbs)
-            item.payload.delete(:breadcrumbs)
-          elsif item.payload.key?("breadcrumbs")
-            item.payload.delete("breadcrumbs")
-          end
-
-          result = item.to_s
-        end
-
-        if result.bytesize > Event::MAX_SERIALIZED_PAYLOAD_SIZE
-          size_breakdown = item.payload.map do |key, value|
-            "#{key}: #{JSON.generate(value).bytesize}"
-          end.join(", ")
-
-          log_debug("Envelope item [#{item.type}] is still oversized without breadcrumbs: {#{size_breakdown}}")
+        if oversized
+          log_info("Envelope item [#{item.type}] is still oversized after size reduction: {#{item.size_breakdown}}")
 
           next
         end

data/lib/sentry/version.rb

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

data/lib/sentry-ruby.rb

@@ -60,11 +60,11 @@ module Sentry
     end
 
     # @!attribute [rw] background_worker
-    #   @return [BackgroundWorker]
+    #   @return [BackgroundWorker, nil]
     attr_accessor :background_worker
 
     # @!attribute [r] session_flusher
-    #   @return [SessionFlusher]
+    #   @return [SessionFlusher, nil]
     attr_reader :session_flusher
 
     ##### Patch Registration #####
@@ -213,10 +213,30 @@ module Sentry
         exception_locals_tp.enable
       end
 
-      at_exit do
-        @session_flusher&.kill
+      at_exit { close }
+    end
+
+    # Flushes pending events and cleans up SDK state.
+    # SDK will stop sending events and all top-level APIs will be no-ops after this.
+    #
+    # @return [void]
+    def close
+      if @background_worker
         @background_worker.shutdown
+        @background_worker = nil
+      end
+
+      if @session_flusher
+        @session_flusher.kill
+        @session_flusher = nil
+      end
+
+      if configuration&.capture_exception_frame_locals
+        exception_locals_tp.disable
       end
+
+      @main_hub = nil
+      Thread.current.thread_variable_set(THREAD_LOCAL, nil)
     end
 
     # Returns true if the SDK is initialized.
@@ -287,6 +307,7 @@ module Sentry
     #
     # @return [void]
     def clone_hub_to_current_thread
+      return unless initialized?
       Thread.current.thread_variable_set(THREAD_LOCAL, get_main_hub.clone)
     end
 
@@ -360,6 +381,25 @@ module Sentry
       get_current_hub.capture_exception(exception, **options, &block)
     end
 
+    # Takes a block and evaluates it. If the block raised an exception, it reports the exception to Sentry and re-raises it.
+    # If the block ran without exception, it returns the evaluation result.
+    #
+    # @example
+    #   Sentry.with_exception_captured do
+    #     1/1 #=> 1 will be returned
+    #   end
+    #
+    #   Sentry.with_exception_captured do
+    #     1/0 #=> ZeroDivisionError will be reported and re-raised
+    #   end
+    #
+    def with_exception_captured(**options, &block)
+      yield
+    rescue Exception => e
+      capture_exception(e, **options)
+      raise
+    end
+
     # Takes a message string and reports it to Sentry via the currently active hub.
     #
     # @yieldparam scope [Scope]
@@ -399,9 +439,7 @@ module Sentry
     #   end
     #
     def with_child_span(**attributes, &block)
-      current_span = get_current_scope.get_span
-
-      if current_span
+      if Sentry.initialized? && current_span = get_current_scope.get_span
         result = nil
 
         begin

data/sentry-ruby-core.gemspec

@@ -18,9 +18,6 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
 
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
+  spec.add_dependency "sentry-ruby", Sentry::VERSION
   spec.add_dependency "concurrent-ruby"
 end

data/sentry-ruby.gemspec

@@ -12,11 +12,13 @@ Gem::Specification.new do |spec|
   spec.platform = Gem::Platform::RUBY
   spec.required_ruby_version = '>= 2.4'
   spec.extra_rdoc_files = ["README.md", "LICENSE.txt"]
+  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples)'`.split("\n")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
 
-  spec.add_dependency "sentry-ruby-core", Sentry::VERSION
+  spec.require_paths = ["lib"]
+
   spec.add_dependency "concurrent-ruby", '~> 1.0', '>= 1.0.2'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby-core
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.4.1
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-04-27 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.4.1
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,7 @@ files:
 - lib/sentry/session.rb
 - lib/sentry/session_flusher.rb
 - lib/sentry/span.rb
+- lib/sentry/test_helper.rb
 - lib/sentry/transaction.rb
 - lib/sentry/transaction_event.rb
 - lib/sentry/transport.rb