sentry-raven 3.0.4 → 3.1.2

data/lib/raven/integrations/rack-timeout.rb

@@ -10,7 +10,11 @@ module RackTimeoutExtensions
     # Only rack-timeout 0.3.0+ provides the request environment, but we can't
     # gate this based on a gem version constant because rack-timeout does
     # not provide one.
-    { :fingerprint => ["{{ default }}", env["REQUEST_URI"]] } if defined?(env)
+    if defined?(env)
+      { :fingerprint => ["{{ default }}", env["REQUEST_URI"]] }
+    else
+      {}
+    end
   end
 end
 

data/lib/raven/integrations/rack.rb

@@ -100,7 +100,7 @@ module Raven
       env_hash.each_with_object({}) do |(key, value), memo|
         begin
           key = key.to_s # rack env can contain symbols
-          value = value.to_s
+          next memo['X-Request-Id'] ||= Utils::RequestId.read_from(env_hash) if Utils::RequestId::REQUEST_ID_HEADERS.include?(key)
           next unless key.upcase == key # Non-upper case stuff isn't either
 
           # Rack adds in an incorrect HTTP_VERSION key, which causes downstream
@@ -110,13 +110,12 @@ module Raven
           # See: https://github.com/rack/rack/blob/028438f/lib/rack/handler/cgi.rb#L29
           next if key == 'HTTP_VERSION' && value == env_hash['SERVER_PROTOCOL']
           next if key == 'HTTP_COOKIE' # Cookies don't go here, they go somewhere else
-
           next unless key.start_with?('HTTP_') || %w(CONTENT_TYPE CONTENT_LENGTH).include?(key)
 
           # Rack stores headers as HTTP_WHAT_EVER, we need What-Ever
           key = key.sub(/^HTTP_/, "")
           key = key.split('_').map(&:capitalize).join('-')
-          memo[key] = value
+          memo[key] = value.to_s
         rescue StandardError => e
           # Rails adds objects to the Rack env that can sometimes raise exceptions
           # when `to_s` is called.
@@ -128,8 +127,10 @@ module Raven
     end
 
     def format_env_for_sentry(env_hash)
+      return env_hash if Raven.configuration.rack_env_whitelist.empty?
+
       env_hash.select do |k, _v|
-        %w(REMOTE_ADDR SERVER_NAME SERVER_PORT).include? k.to_s
+        Raven.configuration.rack_env_whitelist.include? k.to_s
       end
     end
   end

data/lib/raven/integrations/rails.rb

@@ -5,6 +5,7 @@ module Raven
     require 'raven/integrations/rails/overrides/streaming_reporter'
     require 'raven/integrations/rails/controller_methods'
     require 'raven/integrations/rails/controller_transaction'
+    require 'raven/integrations/rails/backtrace_cleaner'
     require 'raven/integrations/rack'
 
     initializer "raven.use_rack_middleware" do |app|
@@ -37,12 +38,20 @@ module Raven
 
     config.before_initialize do
       Raven.configuration.logger = ::Rails.logger
+
+      backtrace_cleaner = Raven::Rails::BacktraceCleaner.new
+
+      Raven.configuration.backtrace_cleanup_callback = lambda do |backtrace|
+        backtrace_cleaner.clean(backtrace)
+      end
     end
 
     config.after_initialize do
-      if Raven.configuration.rails_activesupport_breadcrumbs
-        require 'raven/breadcrumbs/activesupport'
-        Raven::ActiveSupportBreadcrumbs.inject
+      if Raven.configuration.breadcrumbs_logger.include?(:active_support_logger) ||
+         Raven.configuration.rails_activesupport_breadcrumbs
+
+        require 'raven/breadcrumbs/active_support_logger'
+        Raven::Breadcrumbs::ActiveSupportLogger.inject
       end
 
       if Raven.configuration.rails_report_rescued_exceptions

data/lib/raven/integrations/rails/active_job.rb

@@ -21,7 +21,8 @@ module Raven
       def capture_and_reraise_with_sentry(job, block)
         block.call
       rescue Exception => e # rubocop:disable Lint/RescueException
-        return if rescue_with_handler(e)
+        rescue_handler_result = rescue_with_handler(e)
+        return rescue_handler_result if rescue_handler_result
 
         Raven.capture_exception(e, :extra => raven_context(job))
         raise e

data/lib/raven/integrations/rails/backtrace_cleaner.rb

@@ -0,0 +1,29 @@
+require "active_support/backtrace_cleaner"
+require "active_support/core_ext/string/access"
+
+module Raven
+  class Rails
+    class BacktraceCleaner < ActiveSupport::BacktraceCleaner
+      APP_DIRS_PATTERN = /\A(?:\.\/)?(?:app|config|lib|test|\(\w*\))/.freeze
+      RENDER_TEMPLATE_PATTERN = /:in `.*_\w+_{2,3}\d+_\d+'/.freeze
+
+      def initialize
+        super
+        # we don't want any default silencers because they're too aggressive
+        remove_silencers!
+
+        @root = "#{Raven.configuration.project_root}/"
+        add_filter do |line|
+          line.start_with?(@root) ? line.from(@root.size) : line
+        end
+        add_filter do |line|
+          if line =~ RENDER_TEMPLATE_PATTERN
+            line.sub(RENDER_TEMPLATE_PATTERN, "")
+          else
+            line
+          end
+        end
+      end
+    end
+  end
+end

data/lib/raven/integrations/sidekiq.rb

@@ -1,87 +1,13 @@
 require 'time'
 require 'sidekiq'
-
-module Raven
-  class SidekiqCleanupMiddleware
-    def call(_worker, job, queue)
-      Raven.context.transaction.push "Sidekiq/#{job['class']}"
-      Raven.extra_context(:sidekiq => job.merge("queue" => queue))
-      yield
-      Context.clear!
-      BreadcrumbBuffer.clear!
-    end
-  end
-
-  class SidekiqErrorHandler
-    ACTIVEJOB_RESERVED_PREFIX = "_aj_".freeze
-    HAS_GLOBALID = const_defined?('GlobalID')
-
-    def call(ex, context)
-      context = filter_context(context)
-      Raven.context.transaction.push transaction_from_context(context)
-      Raven.capture_exception(
-        ex,
-        :message => ex.message,
-        :extra => { :sidekiq => context }
-      )
-      Context.clear!
-      BreadcrumbBuffer.clear!
-    end
-
-    private
-
-    # Once an ActiveJob is queued, ActiveRecord references get serialized into
-    # some internal reserved keys, such as _aj_globalid.
-    #
-    # The problem is, if this job in turn gets queued back into ActiveJob with
-    # these magic reserved keys, ActiveJob will throw up and error. We want to
-    # capture these and mutate the keys so we can sanely report it.
-    def filter_context(context)
-      case context
-      when Array
-        context.map { |arg| filter_context(arg) }
-      when Hash
-        Hash[context.map { |key, value| filter_context_hash(key, value) }]
-      else
-        format_globalid(context)
-      end
-    end
-
-    def filter_context_hash(key, value)
-      (key = key[3..-1]) if key [0..3] == ACTIVEJOB_RESERVED_PREFIX
-      [key, filter_context(value)]
-    end
-
-    # this will change in the future:
-    # https://github.com/mperham/sidekiq/pull/3161
-    def transaction_from_context(context)
-      classname = (context["wrapped"] || context["class"] ||
-                    (context[:job] && (context[:job]["wrapped"] || context[:job]["class"]))
-                  )
-      if classname
-        "Sidekiq/#{classname}"
-      elsif context[:event]
-        "Sidekiq/#{context[:event]}"
-      else
-        "Sidekiq"
-      end
-    end
-
-    def format_globalid(context)
-      if HAS_GLOBALID && context.is_a?(GlobalID)
-        context.to_s
-      else
-        context
-      end
-    end
-  end
-end
+require 'raven/integrations/sidekiq/cleanup_middleware'
+require 'raven/integrations/sidekiq/error_handler'
 
 if Sidekiq::VERSION > '3'
   Sidekiq.configure_server do |config|
-    config.error_handlers << Raven::SidekiqErrorHandler.new
+    config.error_handlers << Raven::Sidekiq::ErrorHandler.new
     config.server_middleware do |chain|
-      chain.add Raven::SidekiqCleanupMiddleware
+      chain.add Raven::Sidekiq::CleanupMiddleware
     end
   end
 end

data/lib/raven/integrations/sidekiq/cleanup_middleware.rb

@@ -0,0 +1,13 @@
+module Raven
+  module Sidekiq
+    class CleanupMiddleware
+      def call(_worker, job, queue)
+        Raven.context.transaction.push "Sidekiq/#{job['class']}"
+        Raven.extra_context(:sidekiq => job.merge("queue" => queue))
+        yield
+        Context.clear!
+        BreadcrumbBuffer.clear!
+      end
+    end
+  end
+end

data/lib/raven/integrations/sidekiq/error_handler.rb

@@ -0,0 +1,38 @@
+require 'raven/utils/context_filter'
+
+module Raven
+  module Sidekiq
+    class ErrorHandler
+      SIDEKIQ_NAME = "Sidekiq".freeze
+
+      def call(ex, context)
+        context = Utils::ContextFilter.filter_context(context)
+        Raven.context.transaction.push transaction_from_context(context)
+        Raven.capture_exception(
+          ex,
+          :message => ex.message,
+          :extra => { :sidekiq => context }
+        )
+        Context.clear!
+        BreadcrumbBuffer.clear!
+      end
+
+      private
+
+      # this will change in the future:
+      # https://github.com/mperham/sidekiq/pull/3161
+      def transaction_from_context(context)
+        classname = (context["wrapped"] || context["class"] ||
+                      (context[:job] && (context[:job]["wrapped"] || context[:job]["class"]))
+                    )
+        if classname
+          "#{SIDEKIQ_NAME}/#{classname}"
+        elsif context[:event]
+          "#{SIDEKIQ_NAME}/#{context[:event]}"
+        else
+          SIDEKIQ_NAME
+        end
+      end
+    end
+  end
+end

data/lib/raven/transports/http.rb

@@ -1,7 +1,5 @@
 require 'faraday'
 
-require 'raven/transports'
-
 module Raven
   module Transports
     class HTTP < Transport
@@ -15,7 +13,8 @@ module Raven
 
       def send_event(auth_header, data, options = {})
         unless configuration.sending_allowed?
-          logger.debug("Event not sent: #{configuration.error_messages}")
+          configuration.logger.debug("Event not sent: #{configuration.error_messages}")
+          return
         end
 
         project_id = configuration[:project_id]

data/lib/raven/utils/context_filter.rb

@@ -0,0 +1,42 @@
+module Raven
+  module Utils
+    module ContextFilter
+      class << self
+        ACTIVEJOB_RESERVED_PREFIX_REGEX = /^_aj_/.freeze
+        HAS_GLOBALID = const_defined?('GlobalID')
+
+        # Once an ActiveJob is queued, ActiveRecord references get serialized into
+        # some internal reserved keys, such as _aj_globalid.
+        #
+        # The problem is, if this job in turn gets queued back into ActiveJob with
+        # these magic reserved keys, ActiveJob will throw up and error. We want to
+        # capture these and mutate the keys so we can sanely report it.
+        def filter_context(context)
+          case context
+          when Array
+            context.map { |arg| filter_context(arg) }
+          when Hash
+            Hash[context.map { |key, value| filter_context_hash(key, value) }]
+          else
+            format_globalid(context)
+          end
+        end
+
+        private
+
+        def filter_context_hash(key, value)
+          key = key.to_s.sub(ACTIVEJOB_RESERVED_PREFIX_REGEX, "") if key.match(ACTIVEJOB_RESERVED_PREFIX_REGEX)
+          [key, filter_context(value)]
+        end
+
+        def format_globalid(context)
+          if HAS_GLOBALID && context.is_a?(GlobalID)
+            context.to_s
+          else
+            context
+          end
+        end
+      end
+    end
+  end
+end

data/lib/raven/utils/request_id.rb

@@ -0,0 +1,16 @@
+module Raven
+  module Utils
+    module RequestId
+      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)
+        REQUEST_ID_HEADERS.each do |key|
+          request_id = env_hash[key]
+          return request_id if request_id
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/raven/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Raven
-  VERSION = "3.0.4"
+  VERSION = "3.1.2"
 end

data/lib/sentry-raven-without-integrations.rb

@@ -1 +1,6 @@
-require 'raven/base'
+require "raven/helpers/deprecation_helper"
+
+filename = "sentry_raven_without_integrations"
+DeprecationHelper.deprecate_dasherized_filename(filename)
+
+require filename

data/lib/sentry_raven_without_integrations.rb

@@ -0,0 +1 @@
+require 'raven/base'

data/sentry-raven.gemspec

@@ -18,4 +18,11 @@ Gem::Specification.new do |gem|
   gem.executables = "raven"
 
   gem.add_dependency "faraday", ">= 1.0"
+
+  gem.post_install_message = <<~EOS
+    `sentry-raven` is deprecated! Please migrate to `sentry-ruby`
+
+    See https://docs.sentry.io/platforms/ruby/migration for the migration guide.
+
+  EOS
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.1.2
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-28 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -34,17 +34,11 @@ extra_rdoc_files:
 - LICENSE
 files:
 - ".craft.yml"
-- ".github/workflows/test.yml"
-- ".github/workflows/zeus_upload.yml"
-- ".gitignore"
-- ".gitmodules"
-- ".rspec"
-- ".rubocop.yml"
-- ".scripts/bump-version.sh"
+- ".scripts/bump-version.rb"
 - CHANGELOG.md
-- CONTRIUTING.md
 - Gemfile
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
 - exe/raven
@@ -52,8 +46,9 @@ files:
 - lib/raven/backtrace.rb
 - lib/raven/base.rb
 - lib/raven/breadcrumbs.rb
-- lib/raven/breadcrumbs/activesupport.rb
+- lib/raven/breadcrumbs/active_support_logger.rb
 - lib/raven/breadcrumbs/logger.rb
+- lib/raven/breadcrumbs/sentry_logger.rb
 - lib/raven/cli.rb
 - lib/raven/client.rb
 - lib/raven/configuration.rb
@@ -61,12 +56,14 @@ files:
 - lib/raven/core_ext/object/deep_dup.rb
 - lib/raven/core_ext/object/duplicable.rb
 - lib/raven/event.rb
+- lib/raven/helpers/deprecation_helper.rb
 - lib/raven/instance.rb
 - lib/raven/integrations/delayed_job.rb
 - lib/raven/integrations/rack-timeout.rb
 - lib/raven/integrations/rack.rb
 - lib/raven/integrations/rails.rb
 - lib/raven/integrations/rails/active_job.rb
+- lib/raven/integrations/rails/backtrace_cleaner.rb
 - lib/raven/integrations/rails/controller_methods.rb
 - lib/raven/integrations/rails/controller_transaction.rb
 - lib/raven/integrations/rails/overrides/debug_exceptions_catcher.rb
@@ -74,6 +71,8 @@ files:
 - lib/raven/integrations/railties.rb
 - lib/raven/integrations/rake.rb
 - lib/raven/integrations/sidekiq.rb
+- lib/raven/integrations/sidekiq/cleanup_middleware.rb
+- lib/raven/integrations/sidekiq/error_handler.rb
 - lib/raven/integrations/tasks.rb
 - lib/raven/interface.rb
 - lib/raven/interfaces/exception.rb
@@ -95,18 +94,25 @@ files:
 - lib/raven/transports/dummy.rb
 - lib/raven/transports/http.rb
 - lib/raven/transports/stdout.rb
+- lib/raven/utils/context_filter.rb
 - lib/raven/utils/deep_merge.rb
 - lib/raven/utils/exception_cause_chain.rb
 - lib/raven/utils/real_ip.rb
+- lib/raven/utils/request_id.rb
 - lib/raven/version.rb
 - lib/sentry-raven-without-integrations.rb
 - lib/sentry-raven.rb
+- lib/sentry_raven_without_integrations.rb
 - sentry-raven.gemspec
 homepage: https://github.com/getsentry/raven-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message: |+
+  `sentry-raven` is deprecated! Please migrate to `sentry-ruby`
+
+  See https://docs.sentry.io/platforms/ruby/migration for the migration guide.
+
 rdoc_options: []
 require_paths:
 - lib