sentry-ruby-core 4.4.2 → 5.0.0

data/lib/sentry-ruby.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "English"
 require "forwardable"
 require "time"
@@ -16,7 +18,6 @@ require "sentry/transaction"
 require "sentry/hub"
 require "sentry/background_worker"
 
-
 [
   "sentry/rake",
   "sentry/rack",
@@ -32,56 +33,126 @@ module Sentry
 
   LOGGER_PROGNAME = "sentry".freeze
 
-  THREAD_LOCAL = :sentry_hub
-
-  def self.sdk_meta
-    META
-  end
+  SENTRY_TRACE_HEADER_NAME = "sentry-trace".freeze
 
-  def self.utc_now
-    Time.now.utc
-  end
+  THREAD_LOCAL = :sentry_hub
 
   class << self
-    # Returns a hash that contains all the integrations that have been registered to the main SDK.
-    def integrations
-      @integrations ||= {}
-    end
+    # @!visibility private
+    def exception_locals_tp
+      @exception_locals_tp ||= TracePoint.new(:raise) do |tp|
+        exception = tp.raised_exception
 
-    # Registers the SDK integration with its name and version.
-    def register_integration(name, version)
-      meta = { name: "sentry.ruby.#{name}", version: version }.freeze
-      integrations[name.to_s] = meta
-    end
-  end
+        # don't collect locals again if the exception is re-raised
+        next if exception.instance_variable_get(:@sentry_locals)
+        next unless tp.binding
 
-  class << self
-    extend Forwardable
+        locals = tp.binding.local_variables.each_with_object({}) do |local, result|
+          result[local] = tp.binding.local_variable_get(local)
+        end
 
-    def_delegators :get_current_client, :configuration, :send_event
-    def_delegators :get_current_scope, :set_tags, :set_extras, :set_user, :set_context
+        exception.instance_variable_set(:@sentry_locals, locals)
+      end
+    end
 
+    # @!attribute [rw] background_worker
+    #   @return [BackgroundWorker]
     attr_accessor :background_worker
 
-    @@registered_patches = []
+    ##### 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
+      @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
+
+    # @!macro [new] configuration
+    #   The Configuration object that's used for configuring the client and its transport.
+    #   @return [Configuration]
+    # @!macro [new] send_event
+    #   Sends the event to Sentry.
+    #   @param event [Event] the event to be sent.
+    #   @param hint [Hash] the hint data that'll be passed to `before_send` callback.
+    #   @return [Event]
+
+    # @!method configuration
+    #   @!macro configuration
+    # @!method send_event
+    #   @!macro send_event
+    def_delegators :get_current_client, :configuration, :send_event
+
+    # @!macro [new] set_extras
+    #   Updates the scope's extras attribute by merging with the old value.
+    #   @param extras [Hash]
+    #   @return [Hash]
+    # @!macro [new] set_user
+    #   Sets the scope's user attribute.
+    #   @param user [Hash]
+    #   @return [Hash]
+    # @!macro [new] set_context
+    #   Adds a new key-value pair to current contexts.
+    #   @param key [String, Symbol]
+    #   @param value [Object]
+    #   @return [Hash]
+    # @!macro [new] set_tags
+    #   Updates the scope's tags attribute by merging with the old value.
+    #   @param tags [Hash]
+    #   @return [Hash]
+
+    # @!method set_tags
+    #   @!macro set_tags
+    # @!method set_extras
+    #   @!macro set_extras
+    # @!method set_user
+    #   @!macro set_user
+    # @!method set_context
+    #   @!macro set_context
+    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?
+      config.detect_release
       apply_patches(config)
       client = Client.new(config)
       scope = Scope.new(max_breadcrumbs: config.max_breadcrumbs)
@@ -89,21 +160,55 @@ module Sentry
       Thread.current.thread_variable_set(THREAD_LOCAL, hub)
       @main_hub = hub
       @background_worker = Sentry::BackgroundWorker.new(config)
+
+      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?
+      !!get_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.
+    #
+    # @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.
-    def add_breadcrumb(breadcrumb)
-      get_current_hub&.add_breadcrumb(breadcrumb)
+    #
+    # @return [Breadcrumb, nil]
+    def add_breadcrumb(breadcrumb, **options)
+      get_current_hub&.add_breadcrumb(breadcrumb, **options)
     end
 
     # 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
       #
@@ -114,82 +219,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)
@@ -197,13 +325,20 @@ 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
   end
 end
 

data/sentry-ruby-core.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Sentry Team"]
   spec.description = spec.summary = "A gem that provides a client interface for the Sentry error logger"
   spec.email = "accounts@sentry.io"
-  spec.license = 'Apache-2.0'
+  spec.license = 'MIT'
   spec.homepage = "https://github.com/getsentry/sentry-ruby"
 
   spec.platform = Gem::Platform::RUBY
@@ -16,12 +16,11 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/sentry-ruby/CHANGELOG.md"
+  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 "faraday"
   spec.add_dependency "concurrent-ruby"
 end

data/sentry-ruby.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Sentry Team"]
   spec.description = spec.summary = "A gem that provides a client interface for the Sentry error logger"
   spec.email = "accounts@sentry.io"
-  spec.license = 'Apache-2.0'
+  spec.license = 'MIT'
   spec.homepage = "https://github.com/getsentry/sentry-ruby"
 
   spec.platform = Gem::Platform::RUBY
@@ -15,9 +15,8 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/sentry-ruby/CHANGELOG.md"
+  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 "concurrent-ruby", '~> 1.0', '>= 1.0.2'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby-core
 version: !ruby/object:Gem::Version
-  version: 4.4.2
+  version: 5.0.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -46,9 +32,9 @@ extra_rdoc_files:
 - README.md
 - LICENSE.txt
 files:
-- ".craft.yml"
 - ".gitignore"
 - ".rspec"
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -61,7 +47,6 @@ files:
 - lib/sentry-ruby.rb
 - lib/sentry/background_worker.rb
 - lib/sentry/backtrace.rb
-- lib/sentry/benchmarks/benchmark_transport.rb
 - lib/sentry/breadcrumb.rb
 - lib/sentry/breadcrumb/sentry_logger.rb
 - lib/sentry/breadcrumb_buffer.rb
@@ -70,6 +55,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
@@ -86,8 +72,8 @@ files:
 - lib/sentry/net/http.rb
 - lib/sentry/rack.rb
 - lib/sentry/rack/capture_exceptions.rb
-- lib/sentry/rack/deprecations.rb
 - lib/sentry/rake.rb
+- lib/sentry/release_detector.rb
 - lib/sentry/scope.rb
 - lib/sentry/span.rb
 - lib/sentry/transaction.rb
@@ -97,6 +83,7 @@ files:
 - lib/sentry/transport/dummy_transport.rb
 - lib/sentry/transport/http_transport.rb
 - lib/sentry/utils/argument_checking_helper.rb
+- lib/sentry/utils/custom_inspection.rb
 - lib/sentry/utils/exception_cause_chain.rb
 - lib/sentry/utils/logging_helper.rb
 - lib/sentry/utils/real_ip.rb
@@ -106,11 +93,11 @@ files:
 - sentry-ruby.gemspec
 homepage: https://github.com/getsentry/sentry-ruby
 licenses:
-- Apache-2.0
+- MIT
 metadata:
   homepage_uri: https://github.com/getsentry/sentry-ruby
   source_code_uri: https://github.com/getsentry/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/master/sentry-ruby/CHANGELOG.md
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -126,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A gem that provides a client interface for the Sentry error logger

data/.craft.yml

@@ -1,28 +0,0 @@
-minVersion: '0.13.2'
-github:
-    owner: getsentry
-    repo: sentry-ruby
-changelogPolicy: simple
-preReleaseCommand: ruby ../.scripts/bump-version.rb
-releaseBranchPrefix: release-sentry-ruby
-statusProvider:
-  name: github
-artifactProvider:
-  name: github
-targets:
-    # we always need to make sure sentry-ruby-core is present when pushing to any target
-    - name: gem
-      onlyIfPresent: /^sentry-ruby-core-\d.*\.gem$/
-    - name: registry
-      onlyIfPresent: /^sentry-ruby-core-\d.*\.gem$/
-      type: sdk
-      config:
-          canonical: 'gem:sentry-ruby'
-    - name: registry
-      onlyIfPresent: /^sentry-ruby-core-\d.*\.gem$/
-      type: sdk
-      config:
-          canonical: 'gem:sentry-ruby-core'
-    - name: github
-      onlyIfPresent: /^sentry-ruby-core-\d.*\.gem$/
-      tagPrefix: sentry-ruby-v

data/lib/sentry/benchmarks/benchmark_transport.rb

@@ -1,14 +0,0 @@
-module Sentry
-  class BenchmarkTransport < Transport
-    attr_accessor :events
-
-    def initialize(*)
-      super
-      @events = []
-    end
-
-    def send_event(event)
-      @events << encode(event.to_hash)
-    end
-  end
-end

data/lib/sentry/rack/deprecations.rb

@@ -1,19 +0,0 @@
-module Sentry
-  module Rack
-    class DeprecatedMiddleware
-      def initialize(_)
-        raise Sentry::Error.new <<~MSG
-
-You're seeing this message because #{self.class} has been replaced by Sentry::Rack::CaptureExceptions.
-Removing this middleware from your app and upgrading sentry-rails to 4.1.0+ should solve the issue.
-        MSG
-      end
-    end
-
-    class Tracing < DeprecatedMiddleware
-    end
-
-    class CaptureException < DeprecatedMiddleware
-    end
-  end
-end