sentry-ruby-core 4.4.2 → 4.6.0.pre.beta.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46eeab9b7fdc33dd16bbcdd3c7623dcffdc2e70d1c9af0016c4584a08bf743dd
-  data.tar.gz: 0ebfed842099817048aeb8754f27dfd7e637a66d8b9f64267bd1953cbd1f9645
+  metadata.gz: 3fd251a3cc580751fb454b148652d6cc3236a909ff08b401a4127ca29c8cb596
+  data.tar.gz: '094f5c198cfff5179a7139668a69679e934498dbcfb45ebb418f94e0255a3cc1'
 SHA512:
-  metadata.gz: 76284658bda5c4856caf4017046d7f1d6481a11d9287ab0b9ac8363248d1606c7b7a274c9018b56db33062682ceac0f090d614b154048d9e17da4b0a11c98de1
-  data.tar.gz: 3462df382685823d4cd77ac0278644144b0570c04f15db4b2a58d591de8cb25fe3762f222adaf4bb990934c476bfc49b18dfc072021e96bb3f50943caa3dceca
+  metadata.gz: 97e91ace33cd6158779c4478e9f5d678045dc3c67bcb776040c4e7bd009f8cd7f52bf0c58d2a22e430e339931c7bb9c32a667731abae859427ef0827825bebfa
+  data.tar.gz: 183c877035a4c8e2dfdda837dd048d65a16862aa29cb0c2490cdd974609d28722eefdd7eb2d0f62d07ffde8fab842fbc5c265f89e0d8f843b3c9e1eefef2f0af

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 # Changelog
 
+Individual gem's changelog has been deprecated. Please check the [project changelog](https://github.com/getsentry/sentry-ruby/blob/master/CHANGELOG.md).
+
 ## 4.4.2
 
 - Fix NoMethodError when SDK's dsn is nil [#1433](https://github.com/getsentry/sentry-ruby/pull/1433)

data/Gemfile

@@ -3,8 +3,7 @@ source "https://rubygems.org"
 gem "sentry-ruby-core", path: "./"
 gem "sentry-ruby", path: "./"
 
-# TODO: Remove this if https://github.com/jruby/jruby/issues/6547 is addressed
-gem "i18n", "<= 1.8.7"
+gem "rack" unless ENV["WITHOUT_RACK"] == "1"
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
@@ -12,10 +11,10 @@ gem "rspec-retry"
 gem "webmock"
 gem "timecop"
 gem "codecov", "0.2.12"
-gem "tapping_device"
 
+gem "object_tracer"
+gem "debug", github: "ruby/debug" if RUBY_VERSION.to_f >= 2.6
 gem "pry"
-gem "rack" unless ENV["WITHOUT_RACK"] == "1"
 
 gem "benchmark-ips"
 gem "benchmark_driver"

data/lib/sentry-ruby.rb

@@ -32,6 +32,8 @@ module Sentry
 
   LOGGER_PROGNAME = "sentry".freeze
 
+  SENTRY_TRACE_HEADER_NAME = "sentry-trace".freeze
+
   THREAD_LOCAL = :sentry_hub
 
   def self.sdk_meta
@@ -82,6 +84,7 @@ module Sentry
     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)

data/lib/sentry/breadcrumb.rb

@@ -2,15 +2,16 @@ module Sentry
   class Breadcrumb
     DATA_SERIALIZATION_ERROR_MESSAGE = "[data were removed due to serialization issues]"
 
-    attr_accessor :category, :data, :message, :level, :timestamp, :type
+    attr_accessor :category, :data, :level, :timestamp, :type
+    attr_reader :message
 
     def initialize(category: nil, data: nil, message: nil, timestamp: nil, level: nil, type: nil)
       @category = category
       @data = data || {}
       @level = level
-      @message = message
       @timestamp = timestamp || Sentry.utc_now.to_i
       @type = type
+      self.message = message
     end
 
     def to_hash
@@ -24,6 +25,10 @@ module Sentry
       }
     end
 
+    def message=(msg)
+      @message = (msg || "").byteslice(0..Event::MAX_MESSAGE_SIZE_IN_BYTES)
+    end
+
     private
 
     def serialized_data

data/lib/sentry/client.rb

@@ -30,7 +30,7 @@ module Sentry
 
       if async_block = configuration.async
         dispatch_async_event(async_block, event, hint)
-      elsif hint.fetch(:background, true)
+      elsif configuration.background_worker_threads != 0 && hint.fetch(:background, true)
         dispatch_background_event(event, hint)
       else
         send_event(event, hint)
@@ -95,6 +95,14 @@ module Sentry
       raise
     end
 
+    def generate_sentry_trace(span)
+      return unless configuration.propagate_traces
+
+      trace = span.to_sentry_trace
+      log_debug("[Tracing] Adding #{SENTRY_TRACE_HEADER_NAME} header to outgoing request: #{trace}")
+      trace
+    end
+
     private
 
     def dispatch_background_event(event, hint)

data/lib/sentry/configuration.rb

@@ -106,6 +106,9 @@ module Sentry
     # Set automatically for Rails.
     attr_reader :project_root
 
+    # Insert sentry-trace to outgoing requests' headers
+    attr_accessor :propagate_traces
+
     # Array of rack env parameters to be included in the event sent to sentry.
     attr_accessor :rack_env_whitelist
 
@@ -127,6 +130,9 @@ module Sentry
     # will not be sent to Sentry.
     attr_accessor :send_default_pii
 
+    # Allow to skip Sentry emails within rake tasks
+    attr_accessor :skip_rake_integration
+
     # IP ranges for trusted proxies that will be skipped when calculating IP address.
     attr_accessor :trusted_proxies
 
@@ -190,11 +196,12 @@ module Sentry
       self.linecache = ::Sentry::LineCache.new
       self.logger = ::Sentry::Logger.new(STDOUT)
       self.project_root = Dir.pwd
+      self.propagate_traces = true
 
-      self.release = detect_release
       self.sample_rate = 1.0
       self.send_modules = true
       self.send_default_pii = false
+      self.skip_rake_integration = false
       self.trusted_proxies = []
       self.dsn = ENV['SENTRY_DSN']
       self.server_name = server_name_from_env
@@ -306,10 +313,10 @@ module Sentry
       )
     end
 
-    private
-
     def detect_release
-      detect_release_from_env ||
+      return unless sending_allowed?
+
+      self.release ||= detect_release_from_env ||
         detect_release_from_git ||
         detect_release_from_capistrano ||
         detect_release_from_heroku
@@ -317,6 +324,8 @@ module Sentry
       log_error("Error detecting release", e, debug: debug)
     end
 
+    private
+
     def excluded_exception?(incoming_exception)
       excluded_exception_classes.any? do |excluded_exception|
         matches_exception?(excluded_exception, incoming_exception)

data/lib/sentry/interfaces/request.rb

@@ -57,6 +57,7 @@ module Sentry
         request.POST
       elsif request.body # JSON requests, etc
         data = request.body.read(MAX_BODY_LIMIT)
+        data = data.force_encoding(Encoding::UTF_8) if data.respond_to?(:force_encoding)
         request.body.rewind
         data
       end

data/lib/sentry/net/http.rb

@@ -5,7 +5,36 @@ module Sentry
     module HTTP
       OP_NAME = "net.http"
 
+      # To explain how the entire thing works, we need to know how the original Net::HTTP#request works
+      # Here's part of its definition. As you can see, it usually calls itself inside a #start block
+      #
+      # ```
+      # def request(req, body = nil, &block)
+      #   unless started?
+      #     start {
+      #       req['connection'] ||= 'close'
+      #       return request(req, body, &block) # <- request will be called for the second time from the first call
+      #     }
+      #   end
+      #   # .....
+      # end
+      # ```
+      #
+      # So when the entire flow looks like this:
+      #
+      # 1. #request is called.
+      #   - But because the request hasn't started yet, it calls #start (which then calls #do_start)
+      #   - At this moment @sentry_span is still nil, so #set_sentry_trace_header returns early
+      # 2. #do_start then creates a new Span and assigns it to @sentry_span
+      # 3. #request is called for the second time.
+      #   - This time @sentry_span should present. So #set_sentry_trace_header will set the sentry-trace header on the request object
+      # 4. Once the request finished, it
+      #   - Records a breadcrumb if http_logger is set
+      #   - Finishes the Span inside @sentry_span and clears the instance variable
+      #
       def request(req, body = nil, &block)
+        set_sentry_trace_header(req)
+
         super.tap do |res|
           record_sentry_breadcrumb(req, res)
           record_sentry_span(req, res)
@@ -26,6 +55,13 @@ module Sentry
 
       private
 
+      def set_sentry_trace_header(req)
+        return unless @sentry_span
+
+        trace = Sentry.get_current_client.generate_sentry_trace(@sentry_span)
+        req[SENTRY_TRACE_HEADER_NAME] = trace if trace
+      end
+
       def record_sentry_breadcrumb(req, res)
         if Sentry.initialized? && Sentry.configuration.breadcrumbs_logger.include?(:http_logger)
           return if from_sentry_sdk?

data/lib/sentry/rack.rb

@@ -1,4 +1,3 @@
 require 'rack'
 
 require 'sentry/rack/capture_exceptions'
-require 'sentry/rack/deprecations'

data/lib/sentry/rake.rb

@@ -9,7 +9,7 @@ module Rake
         task_name = top_level_tasks.join(' ')
         scope.set_transaction_name(task_name)
         scope.set_tag("rake_task", task_name)
-      end if Sentry.initialized?
+      end if Sentry.initialized? && !Sentry.configuration.skip_rake_integration
 
       orig_display_error_messsage(ex)
     end

data/lib/sentry/version.rb

@@ -1,3 +1,3 @@
 module Sentry
-  VERSION = "4.4.2"
+  VERSION = "4.6.0-beta.0"
 end

data/sentry-ruby-core.gemspec

@@ -16,7 +16,7 @@ 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) }

data/sentry-ruby.gemspec

@@ -15,7 +15,7 @@ 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby-core
 version: !ruby/object:Gem::Version
-  version: 4.4.2
+  version: 4.6.0.pre.beta.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+date: 2021-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -46,7 +46,6 @@ extra_rdoc_files:
 - README.md
 - LICENSE.txt
 files:
-- ".craft.yml"
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
@@ -61,7 +60,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
@@ -86,7 +84,6 @@ 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/scope.rb
 - lib/sentry/span.rb
@@ -110,7 +107,7 @@ licenses:
 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:
@@ -122,11 +119,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 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