sentry-ruby 4.0.0 → 4.1.3

data/lib/sentry/rack/deprecations.rb

@@ -0,0 +1,19 @@
+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

data/lib/sentry/rake.rb

@@ -0,0 +1,17 @@
+require "rake"
+require "rake/task"
+
+module Rake
+  class Application
+    alias orig_display_error_messsage display_error_message
+    def display_error_message(ex)
+      Sentry.capture_exception(ex, hint: { background: false }) do |scope|
+        task_name = top_level_tasks.join(' ')
+        scope.set_transaction_name(task_name)
+        scope.set_tag("rake_task", task_name)
+      end if Sentry.initialized?
+
+      orig_display_error_messsage(ex)
+    end
+  end
+end

data/lib/sentry/scope.rb

@@ -29,7 +29,7 @@ module Sentry
       event.level = level
       event.transaction = transaction_names.last
       event.breadcrumbs = breadcrumbs
-      event.rack_env = rack_env
+      event.rack_env = rack_env if rack_env
 
       unless @event_processors.empty?
         @event_processors.each do |processor_block|
@@ -57,7 +57,7 @@ module Sentry
       copy.user = user.deep_dup
       copy.transaction_names = transaction_names.deep_dup
       copy.fingerprint = fingerprint.deep_dup
-      copy.span = span
+      copy.span = span.deep_dup
       copy
     end
 

data/lib/sentry/span.rb

@@ -35,11 +35,6 @@ module Sentry
       @tags = {}
     end
 
-    def set_span_recorder
-      @span_recorder = SpanRecorder.new(1000)
-      @span_recorder.add(self)
-    end
-
     def finish
       # already finished
       return if @timestamp
@@ -82,14 +77,7 @@ module Sentry
 
     def start_child(**options)
       options = options.dup.merge(trace_id: @trace_id, parent_span_id: @span_id, sampled: @sampled)
-      child_span = Span.new(options)
-      child_span.span_recorder = @span_recorder
-
-      if @span_recorder && @sampled
-        @span_recorder.add(child_span)
-      end
-
-      child_span
+      Span.new(**options)
     end
 
     def with_child_span(**options, &block)
@@ -100,6 +88,10 @@ module Sentry
       child_span.finish
     end
 
+    def deep_dup
+      dup
+    end
+
     def set_op(op)
       @op = op
     end
@@ -136,20 +128,5 @@ module Sentry
     def set_tag(key, value)
       @tags[key] = value
     end
-
-    class SpanRecorder
-      attr_reader :max_length, :spans
-
-      def initialize(max_length)
-        @max_length = max_length
-        @spans = []
-      end
-
-      def add(span)
-        if @spans.count < @max_length
-          @spans << span
-        end
-      end
-    end
   end
 end

data/lib/sentry/transaction.rb

@@ -20,6 +20,11 @@ module Sentry
       set_span_recorder
     end
 
+    def set_span_recorder
+      @span_recorder = SpanRecorder.new(1000)
+      @span_recorder.add(self)
+    end
+
     def self.from_sentry_trace(sentry_trace, **options)
       return unless sentry_trace
 
@@ -37,6 +42,30 @@ module Sentry
       hash
     end
 
+    def start_child(**options)
+      child_span = super
+      child_span.span_recorder = @span_recorder
+
+      if @sampled
+        @span_recorder.add(child_span)
+      end
+
+      child_span
+    end
+
+    def deep_dup
+      copy = super
+      copy.set_span_recorder
+
+      @span_recorder.spans.each do |span|
+        # span_recorder's first span is the current span, which should not be added to the copy's spans
+        next if span == self
+        copy.span_recorder.add(span.dup)
+      end
+
+      copy
+    end
+
     def set_initial_sample_desicion(sampling_context = {})
       unless Sentry.configuration.tracing_enabled?
         @sampled = false
@@ -109,5 +138,20 @@ module Sentry
       result += " <#{@name}>" if @name
       result
     end
+
+    class SpanRecorder
+      attr_reader :max_length, :spans
+
+      def initialize(max_length)
+        @max_length = max_length
+        @spans = []
+      end
+
+      def add(span)
+        if @spans.count < @max_length
+          @spans << span
+        end
+      end
+    end
   end
 end

data/lib/sentry/transport.rb

@@ -1,20 +1,17 @@
 require "json"
 require "base64"
-require "sentry/transport/state"
 
 module Sentry
   class Transport
     PROTOCOL_VERSION = '5'
     USER_AGENT = "sentry-ruby/#{Sentry::VERSION}"
-    CONTENT_TYPE = 'application/json'
 
-    attr_accessor :configuration, :state
+    attr_accessor :configuration
 
     def initialize(configuration)
       @configuration = configuration
       @transport_configuration = configuration.transport
       @dsn = configuration.dsn
-      @state = State.new
     end
 
     def send_data(data, options = {})
@@ -22,13 +19,17 @@ module Sentry
     end
 
     def send_event(event)
-      content_type, encoded_data = prepare_encoded_event(event)
+      unless configuration.sending_allowed?
+        configuration.logger.debug(LOGGER_PROGNAME) { "Event not sent: #{configuration.error_messages}" }
+        return
+      end
+
+      encoded_data = prepare_encoded_event(event)
 
       return nil unless encoded_data
 
-      send_data(encoded_data, content_type: content_type)
+      send_data(encoded_data)
 
-      state.success
       event
     rescue => e
       failed_for_exception(e, event)
@@ -57,7 +58,7 @@ module Sentry
         #{JSON.generate(event_hash)}
       ENVELOPE
 
-      [CONTENT_TYPE, envelope]
+      envelope
     end
 
     private
@@ -66,27 +67,17 @@ module Sentry
       # Convert to hash
       event_hash = event.to_hash
 
-      unless @state.should_try?
-        failed_for_previous_failure(event_hash)
-        return
-      end
-
-      event_id = event_hash[:event_id] || event_hash['event_id']
-      configuration.logger.info(LOGGER_PROGNAME) { "Sending event #{event_id} to Sentry" }
+      event_id = event_hash[:event_id] || event_hash["event_id"]
+      event_type = event_hash[:type] || event_hash["type"]
+      configuration.logger.info(LOGGER_PROGNAME) { "Sending #{event_type} #{event_id} to Sentry" }
       encode(event_hash)
     end
 
     def failed_for_exception(e, event)
-      @state.failure
       configuration.logger.warn(LOGGER_PROGNAME) { "Unable to record event with remote Sentry server (#{e.class} - #{e.message}):\n#{e.backtrace[0..10].join("\n")}" }
       log_not_sending(event)
     end
 
-    def failed_for_previous_failure(event)
-      configuration.logger.warn(LOGGER_PROGNAME) { "Not sending event due to previous failure(s)." }
-      log_not_sending(event)
-    end
-
     def log_not_sending(event)
       configuration.logger.warn(LOGGER_PROGNAME) { "Failed to submit event. Unreported Event: #{Event.get_log_message(event.to_hash)}" }
     end

data/lib/sentry/transport/http_transport.rb

@@ -2,6 +2,7 @@ require 'faraday'
 
 module Sentry
   class HTTPTransport < Transport
+    CONTENT_TYPE = 'application/json'
     attr_reader :conn, :adapter
 
     def initialize(*args)
@@ -11,13 +12,9 @@ module Sentry
       @endpoint = @dsn.envelope_endpoint
     end
 
-    def send_data(data, options = {})
-      unless configuration.sending_allowed?
-        logger.debug(LOGGER_PROGNAME) { "Event not sent: #{configuration.error_messages}" }
-      end
-
+    def send_data(data)
       conn.post @endpoint do |req|
-        req.headers['Content-Type'] = options[:content_type]
+        req.headers['Content-Type'] = CONTENT_TYPE
         req.headers['X-Sentry-Auth'] = generate_auth_header
         req.body = data
       end

data/lib/sentry/utils/request_id.rb

@@ -4,9 +4,9 @@ module Sentry
       REQUEST_ID_HEADERS = %w(action_dispatch.request_id HTTP_X_REQUEST_ID).freeze
 
       # Request ID based on ActionDispatch::RequestId
-      def self.read_from(env_hash)
+      def self.read_from(env)
         REQUEST_ID_HEADERS.each do |key|
-          request_id = env_hash[key]
+          request_id = env[key]
           return request_id if request_id
         end
         nil

data/lib/sentry/version.rb

@@ -1,3 +1,3 @@
 module Sentry
-  VERSION = "4.0.0"
+  VERSION = "4.1.3"
 end

data/sentry-ruby.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   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
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.3
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-10 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
 description: A gem that provides a client interface for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -45,6 +65,7 @@ files:
 - bin/console
 - bin/setup
 - lib/sentry-ruby.rb
+- lib/sentry/background_worker.rb
 - lib/sentry/backtrace.rb
 - lib/sentry/benchmarks/benchmark_transport.rb
 - lib/sentry/breadcrumb.rb
@@ -57,6 +78,7 @@ files:
 - lib/sentry/dsn.rb
 - lib/sentry/event.rb
 - lib/sentry/hub.rb
+- lib/sentry/integrable.rb
 - lib/sentry/interface.rb
 - lib/sentry/interfaces/exception.rb
 - lib/sentry/interfaces/request.rb
@@ -65,8 +87,9 @@ files:
 - lib/sentry/linecache.rb
 - lib/sentry/logger.rb
 - lib/sentry/rack.rb
-- lib/sentry/rack/capture_exception.rb
-- lib/sentry/rack/tracing.rb
+- lib/sentry/rack/capture_exceptions.rb
+- lib/sentry/rack/deprecations.rb
+- lib/sentry/rake.rb
 - lib/sentry/scope.rb
 - lib/sentry/span.rb
 - lib/sentry/transaction.rb
@@ -75,7 +98,6 @@ files:
 - lib/sentry/transport/configuration.rb
 - lib/sentry/transport/dummy_transport.rb
 - lib/sentry/transport/http_transport.rb
-- lib/sentry/transport/state.rb
 - lib/sentry/utils/exception_cause_chain.rb
 - lib/sentry/utils/real_ip.rb
 - lib/sentry/utils/request_id.rb

data/lib/sentry/rack/capture_exception.rb

@@ -1,45 +0,0 @@
-module Sentry
-  module Rack
-    class CaptureException
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        # this call clones the main (global) hub
-        # and assigns it to the current thread's Sentry#get_current_hub
-        # it's essential for multi-thread servers (e.g. puma)
-        Sentry.clone_hub_to_current_thread unless Sentry.get_current_hub
-        # this call creates an isolated scope for every request
-        # it's essential for multi-process servers (e.g. unicorn)
-        Sentry.with_scope do |scope|
-          # there could be some breadcrumbs already stored in the top-level scope
-          # and for request information, we don't need those breadcrumbs
-          scope.clear_breadcrumbs
-          env['sentry.client'] = Sentry.get_current_client
-
-          scope.set_transaction_name(env["PATH_INFO"]) if env["PATH_INFO"]
-          scope.set_rack_env(env)
-
-          begin
-            response = @app.call(env)
-          rescue Sentry::Error
-            raise # Don't capture Sentry errors
-          rescue Exception => e
-            Sentry.capture_exception(e)
-            raise
-          end
-
-          exception = collect_exception(env)
-          Sentry.capture_exception(exception) if exception
-
-          response
-        end
-      end
-
-      def collect_exception(env)
-        env['rack.exception'] || env['sinatra.error']
-      end
-    end
-  end
-end

data/lib/sentry/rack/tracing.rb

@@ -1,39 +0,0 @@
-module Sentry
-  module Rack
-    class Tracing
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        Sentry.clone_hub_to_current_thread unless Sentry.get_current_hub
-
-        if Sentry.configuration.traces_sample_rate.to_f == 0.0
-          return @app.call(env)
-        end
-
-        Sentry.with_scope do |scope|
-          scope.clear_breadcrumbs
-          scope.set_transaction_name(env["PATH_INFO"]) if env["PATH_INFO"]
-          span = Sentry.start_transaction(name: scope.transaction_name, op: "rack.request")
-          scope.set_span(span)
-
-          begin
-            response = @app.call(env)
-          rescue
-            finish_span(span, 500)
-            raise
-          end
-
-          finish_span(span, response[0])
-          response
-        end
-      end
-
-      def finish_span(span, status_code)
-        span.set_http_status(status_code)
-        span.finish
-      end
-    end
-  end
-end