sentry-raven 2.13.0 → 3.1.2

data/lib/raven/event.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'socket'
 require 'securerandom'
 
@@ -7,6 +8,7 @@ module Raven
     # See Sentry server default limits at
     # https://github.com/getsentry/sentry/blob/master/src/sentry/conf/server.py
     MAX_MESSAGE_SIZE_IN_BYTES = 1024 * 8
+    REQUIRED_OPTION_KEYS = [:configuration, :context, :breadcrumbs].freeze
 
     SDK = { "name" => "raven-ruby", "version" => Raven::VERSION }.freeze
 
@@ -18,7 +20,7 @@ module Raven
 
     attr_reader :level, :timestamp, :time_spent
 
-    def initialize(init = {})
+    def initialize(options)
       # Set some simple default values
       self.id            = SecureRandom.uuid.delete("-")
       self.timestamp     = Time.now.utc
@@ -35,11 +37,17 @@ module Raven
       self.runtime       = {} # TODO: contexts
       self.tags          = {} # TODO: contexts
 
-      copy_initial_state
+      unless REQUIRED_OPTION_KEYS.all? { |key| options.key?(key) }
+        raise "you must provide configuration, context, and breadcrumbs when initializing a Raven::Event"
+      end
+
+      self.configuration = options[:configuration]
+      self.context       = options[:context]
+      self.breadcrumbs   = options[:breadcrumbs]
 
       # Allow attributes to be set on the event at initialization
       yield self if block_given?
-      init.each_pair { |key, val| public_send("#{key}=", val) unless val.nil? }
+      options.each_pair { |key, val| public_send("#{key}=", val) unless val.nil? }
 
       set_core_attributes_from_configuration
       set_core_attributes_from_context
@@ -55,8 +63,7 @@ module Raven
                           end
       options = Raven::Utils::DeepMergeHash.deep_merge(exception_context, options)
 
-      configuration = options[:configuration] || Raven.configuration
-      return unless configuration.exception_class_allowed?(exc)
+      return unless options[:configuration].exception_class_allowed?(exc)
 
       new(options) do |evt|
         evt.add_exception_interface(exc)
@@ -76,11 +83,21 @@ module Raven
     end
 
     def message
-      @interfaces[:logentry] && @interfaces[:logentry].unformatted_message
+      @interfaces[:logentry]&.unformatted_message
     end
 
     def message=(args)
-      message, params = *args
+      if args.is_a?(Array)
+        message, params = args[0], args[0..-1]
+      else
+        message = args
+      end
+
+      unless message.is_a?(String)
+        configuration.logger.debug("You're passing a non-string message")
+        message = message.to_s
+      end
+
       interface(:message) do |int|
         int.message = message.byteslice(0...MAX_MESSAGE_SIZE_IN_BYTES) # Messages limited to 10kb
         int.params = params
@@ -96,12 +113,13 @@ module Raven
     end
 
     def level=(new_level) # needed to meet the Sentry spec
-      @level = new_level == "warn" || new_level == :warn ? :warning : new_level
+      @level = new_level.to_s == "warn" ? :warning : new_level
     end
 
     def interface(name, value = nil, &block)
       int = Interface.registered[name]
       raise(Error, "Unknown interface: #{name}") unless int
+
       @interfaces[int.sentry_alias] = int.new(value, &block) if value || block
       @interfaces[int.sentry_alias]
     end
@@ -157,7 +175,7 @@ module Raven
     end
 
     def stacktrace_interface_from(backtrace)
-      Backtrace.parse(backtrace).lines.reverse.each_with_object([]) do |line, memo|
+      Backtrace.parse(backtrace, { configuration: configuration }).lines.reverse.each_with_object([]) do |line, memo|
         frame = StacktraceInterface::Frame.new
         frame.abs_path = line.file if line.file
         frame.function = line.method if line.method
@@ -184,12 +202,6 @@ module Raven
 
     private
 
-    def copy_initial_state
-      self.configuration = Raven.configuration
-      self.breadcrumbs   = Raven.breadcrumbs
-      self.context       = Raven.context
-    end
-
     def set_core_attributes_from_configuration
       self.server_name ||= configuration.server_name
       self.release     ||= configuration.release
@@ -214,6 +226,10 @@ module Raven
         int.from_rack(context.rack_env)
       end
       context.user[:ip_address] = calculate_real_ip_from_rack
+
+      if request_id = Utils::RequestId.read_from(context.rack_env)
+        context.tags[:request_id] = request_id
+      end
     end
 
     # When behind a proxy (or if the user is using a proxy), we can't use

data/lib/raven/helpers/deprecation_helper.rb

@@ -0,0 +1,17 @@
+module DeprecationHelper
+  def self.deprecate_dasherized_filename(correct_filename)
+    warn "[Deprecation Warning] Dasherized filename \"#{correct_filename.gsub('_', '-')}\" is deprecated and will be removed in 4.0; use \"#{correct_filename}\" instead" # rubocop:disable Style/LineLength
+  end
+
+  def self.deprecate_old_breadcrumbs_configuration(logger)
+    deprecated_usage =
+      if logger == :sentry_logger
+        "require \"raven/breadcrumbs/logger\""
+      else
+        "Raven.configuration.rails_activesupport_breadcrumbs = true"
+      end
+    recommended_usage = "Raven.configuration.breadcrumbs_logger = :#{logger}"
+
+    warn "[Deprecation Warning] The way you enable breadcrumbs logger (#{deprecated_usage}) is deprecated and will be removed in 4.0; use '#{recommended_usage}' instead" # rubocop:disable Style/LineLength
+  end
+end

data/lib/raven/instance.rb

@@ -50,7 +50,9 @@ module Raven
 
     # Tell the log that the client is good to go
     def report_status
+      return unless configuration.enabled_in_current_env?
       return if configuration.silence_ready
+
       if configuration.capture_allowed?
         logger.info "Raven #{VERSION} ready to catch errors"
       else
@@ -75,7 +77,7 @@ module Raven
     # Send an event to the configured Sentry server
     #
     # @example
-    #   evt = Raven::Event.new(:message => "An error")
+    #   evt = Raven::Event.new(:message => "An errore)
     #   Raven.send_event(evt)
     def send_event(event, hint = nil)
       client.send_event(event, hint)
@@ -109,17 +111,20 @@ module Raven
       end
 
       message_or_exc = obj.is_a?(String) ? "message" : "exception"
+      options = options.deep_dup
       options[:configuration] = configuration
       options[:context] = context
-      if (evt = Event.send("from_" + message_or_exc, obj, options))
+      options[:breadcrumbs] = breadcrumbs
+
+      if evt = Event.send("from_" + message_or_exc, obj, options)
         yield evt if block_given?
         if configuration.async?
           begin
             # We have to convert to a JSON-like hash, because background job
             # processors (esp ActiveJob) may not like weird types in the event hash
             configuration.async.call(evt.to_json_compatible)
-          rescue => ex
-            logger.error("async event sending failed: #{ex.message}")
+          rescue => e
+            logger.error("async event sending failed: #{e.message}")
             send_event(evt, make_hint(obj))
           end
         else
@@ -171,7 +176,18 @@ module Raven
     # @example
     #   Raven.user_context('id' => 1, 'email' => 'foo@example.com')
     def user_context(options = nil)
-      context.user = options || {}
+      original_user_context = context.user
+
+      if options
+        context.user.merge!(options)
+      else
+        context.user = {}
+      end
+
+      yield if block_given?
+      context.user
+    ensure
+      context.user = original_user_context if block_given?
     end
 
     # Bind tags context. Merges with existing context (if any).

data/lib/raven/integrations/delayed_job.rb

@@ -1,4 +1,5 @@
 require 'delayed_job'
+require 'raven/utils/context_filter'
 
 module Delayed
   module Plugins
@@ -8,19 +9,18 @@ module Delayed
           begin
             # Forward the call to the next callback in the callback chain
             block.call(job, *args)
-
-          rescue Exception => exception
+          rescue Exception => e
             # Log error to Sentry
             extra = {
               :delayed_job => {
-                :id          => job.id.to_s,
-                :priority    => job.priority,
-                :attempts    => job.attempts,
-                :run_at      => job.run_at,
-                :locked_at   => job.locked_at,
-                :locked_by   => job.locked_by,
-                :queue       => job.queue,
-                :created_at  => job.created_at
+                :id => job.id.to_s,
+                :priority => job.priority,
+                :attempts => job.attempts,
+                :run_at => job.run_at,
+                :locked_at => job.locked_at,
+                :locked_by => job.locked_by,
+                :queue => job.queue,
+                :created_at => job.created_at
               }
             }
             # last_error can be nil
@@ -30,18 +30,18 @@ module Delayed
             extra[:handler] = job.handler[0...1000] if job.handler
 
             if job.respond_to?('payload_object') && job.payload_object.respond_to?('job_data')
-              extra[:active_job] = job.payload_object.job_data
+              extra[:active_job] = ::Raven::Utils::ContextFilter.filter_context(job.payload_object.job_data)
             end
-            ::Raven.capture_exception(exception,
-                                      :logger  => 'delayed_job',
-                                      :tags    => {
+            ::Raven.capture_exception(e,
+                                      :logger => 'delayed_job',
+                                      :tags => {
                                         :delayed_job_queue => job.queue,
                                         :delayed_job_id => job.id.to_s
                                       },
                                       :extra => extra)
 
             # Make sure we propagate the failure!
-            raise exception
+            raise e
           ensure
             ::Raven::Context.clear!
             ::Raven::BreadcrumbBuffer.clear!

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

@@ -10,10 +10,13 @@ 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
 
-# Include is private in Ruby 1.9
-Rack::Timeout::Error.__send__(:include, RackTimeoutExtensions)
-Rack::Timeout::RequestTimeoutException.__send__(:include, RackTimeoutExtensions)
+Rack::Timeout::Error.include(RackTimeoutExtensions)
+Rack::Timeout::RequestTimeoutException.include(RackTimeoutExtensions)

data/lib/raven/integrations/rack.rb

@@ -92,15 +92,15 @@ module Raven
         request.body.rewind
         data
       end
-    rescue IOError => ex
-      ex.message
+    rescue IOError => e
+      e.message
     end
 
     def format_headers_for_sentry(env_hash)
       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,12 +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.gsub("HTTP_", "")
+          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.
@@ -127,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/active_job.rb

@@ -20,10 +20,12 @@ module Raven
 
       def capture_and_reraise_with_sentry(job, block)
         block.call
-      rescue Exception => exception # rubocop:disable Lint/RescueException
-        return if rescue_with_handler(exception)
-        Raven.capture_exception(exception, :extra => raven_context(job))
-        raise exception
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        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
       ensure
         Context.clear!
         BreadcrumbBuffer.clear!

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/rails/overrides/debug_exceptions_catcher.rb

@@ -6,7 +6,7 @@ module Raven
           begin
             env = env_or_request.respond_to?(:env) ? env_or_request.env : env_or_request
             Raven::Rack.capture_exception(exception, env)
-          rescue # rubocop:disable Lint/HandleExceptions
+          rescue
           end
           super
         end
@@ -21,7 +21,7 @@ module Raven
           begin
             env = env_or_request.respond_to?(:env) ? env_or_request.env : env_or_request
             Raven::Rack.capture_exception(exception, env)
-          rescue # rubocop:disable Lint/HandleExceptions
+          rescue
           end
           render_exception_without_raven(env_or_request, exception)
         end

data/lib/raven/integrations/rails.rb

@@ -5,6 +5,8 @@ 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|
       app.config.middleware.insert 0, Raven::Rack
@@ -36,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/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/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/interface.rb

@@ -1,9 +1,9 @@
 module Raven
   class Interface
     def initialize(attributes = nil)
-      attributes.each do |attr, value|
+      attributes&.each do |attr, value|
         public_send "#{attr}=", value
-      end if attributes
+      end
 
       yield self if block_given?
     end

data/lib/raven/interfaces/stack_trace.rb

@@ -58,7 +58,7 @@ module Raven
       end
 
       def project_root
-        @project_root ||= Raven.configuration.project_root && Raven.configuration.project_root.to_s
+        @project_root ||= Raven.configuration.project_root&.to_s
       end
 
       def longest_load_path

data/lib/raven/linecache.rb

@@ -10,6 +10,7 @@ module Raven
     # line should be the line requested by lineno. See specs for more information.
     def get_file_context(filename, lineno, context)
       return nil, nil, nil unless valid_path?(filename)
+
       lines = Array.new(2 * context + 1) do |i|
         getline(filename, lineno - context + i)
       end
@@ -26,15 +27,17 @@ module Raven
     def getlines(path)
       @cache[path] ||= begin
         IO.readlines(path)
-      rescue
-        nil
+                       rescue
+                         nil
       end
     end
 
     def getline(path, n)
       return nil if n < 1
+
       lines = getlines(path)
       return nil if lines.nil?
+
       lines[n - 1]
     end
   end

data/lib/raven/logger.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+
 require 'logger'
 
 module Raven
   class Logger < ::Logger
-    LOG_PREFIX = "** [Raven] ".freeze
-    PROGNAME   = "sentry".freeze
+    LOG_PREFIX = "** [Raven] "
+    PROGNAME   = "sentry"
 
     def initialize(*)
       super

data/lib/raven/processor/cookies.rb

@@ -10,17 +10,27 @@ module Raven
     private
 
     def process_if_symbol_keys(data)
-      data[:request][:cookies] = STRING_MASK if data[:request][:cookies]
+      if cookies = data.dig(:request, :cookies)
+        data[:request][:cookies] = generate_masked_cookies(cookies)
+      end
 
-      return unless data[:request][:headers] && data[:request][:headers]["Cookie"]
-      data[:request][:headers]["Cookie"] = STRING_MASK
+      if cookies_header = data[:request][:headers]["Cookie"]
+        data[:request][:headers]["Cookie"] = generate_masked_cookies(cookies_header)
+      end
     end
 
     def process_if_string_keys(data)
-      data["request"]["cookies"] = STRING_MASK if data["request"]["cookies"]
+      if cookies = data.dig("request", "cookies")
+        data["request"]["cookies"] = generate_masked_cookies(cookies)
+      end
 
-      return unless data["request"]["headers"] && data["request"]["headers"]["Cookie"]
-      data["request"]["headers"]["Cookie"] = STRING_MASK
+      if cookies_header = data.dig("request", "headers", "Cookie")
+        data["request"]["headers"]["Cookie"] = generate_masked_cookies(cookies_header)
+      end
+    end
+
+    def generate_masked_cookies(cookies)
+      cookies.merge(cookies) { STRING_MASK } if cookies.respond_to?(:merge)
     end
   end
 end