sentry-raven 2.13.0 → 3.1.2

data/lib/raven/processor/post_data.rb

@@ -11,11 +11,13 @@ module Raven
 
     def process_if_symbol_keys(data)
       return unless data[:request][:method] == "POST"
+
       data[:request][:data] = STRING_MASK
     end
 
     def process_if_string_keys(data)
       return unless data["request"]["method"] == "POST"
+
       data["request"]["data"] = STRING_MASK
     end
   end

data/lib/raven/processor/removecircularreferences.rb

@@ -1,7 +1,9 @@
 module Raven
   class Processor::RemoveCircularReferences < Processor
+    ELISION_STRING = "(...)".freeze
     def process(value, visited = [])
-      return "(...)" if visited.include?(value.__id__)
+      return ELISION_STRING if visited.include?(value.__id__)
+
       visited << value.__id__ if value.is_a?(Array) || value.is_a?(Hash)
 
       case value

data/lib/raven/processor/sanitizedata.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+
 require 'json'
 
 module Raven
   class Processor::SanitizeData < Processor
     DEFAULT_FIELDS = %w(authorization password passwd secret ssn social(.*)?sec).freeze
-    CREDIT_CARD_RE = /\b(?:3[47]\d|(?:4\d|5[1-5]|65)\d{2}|6011)\d{12}\b/
+    CREDIT_CARD_RE = /\b(?:3[47]\d|(?:4\d|5[1-5]|65)\d{2}|6011)\d{12}\b/.freeze
     QUERY_STRING = ['query_string', :query_string].freeze
     JSON_STARTS_WITH = ["[", "{"].freeze
 
@@ -20,22 +21,13 @@ module Raven
     def process(value, key = nil)
       case value
       when Hash
-        !value.frozen? ? value.merge!(value) { |k, v| process v, k } : value.merge(value) { |k, v| process v, k }
+        sanitize_hash_value(key, value)
       when Array
-        !value.frozen? ? value.map! { |v| process v, key } : value.map { |v| process v, key }
+        sanitize_array_value(key, value)
       when Integer
         matches_regexes?(key, value.to_s) ? INT_MASK : value
       when String
-        if value =~ fields_re && (json = parse_json_or_nil(value))
-          # if this string is actually a json obj, convert and sanitize
-          process(json).to_json
-        elsif matches_regexes?(key, value)
-          STRING_MASK
-        elsif QUERY_STRING.include?(key)
-          sanitize_query_string(value)
-        else
-          value
-        end
+        sanitize_string_value(key, value)
       else
         value
       end
@@ -49,6 +41,39 @@ module Raven
       @utf8_processor ||= Processor::UTF8Conversion.new
     end
 
+    def sanitize_hash_value(key, value)
+      if key =~ sensitive_fields
+        STRING_MASK
+      elsif value.frozen?
+        value.merge(value) { |k, v| process v, k }
+      else
+        value.merge!(value) { |k, v| process v, k }
+      end
+    end
+
+    def sanitize_array_value(key, value)
+      if value.frozen?
+        value.map { |v| process v, key }
+      else
+        value.map! { |v| process v, key }
+      end
+    end
+
+    def sanitize_string_value(key, value)
+      if value =~ sensitive_fields && (json = parse_json_or_nil(value))
+        # if this string is actually a json obj, convert and sanitize
+        process(json).to_json
+      elsif matches_regexes?(key, value)
+        STRING_MASK
+      elsif QUERY_STRING.include?(key)
+        sanitize_query_string(value)
+      elsif value =~ sensitive_fields
+        sanitize_sensitive_string_content(value)
+      else
+        value
+      end
+    end
+
     def sanitize_query_string(query_string)
       query_hash = CGI.parse(query_string)
       sanitized = utf8_processor.process(query_hash)
@@ -56,16 +81,38 @@ module Raven
       URI.encode_www_form(processed_query_hash)
     end
 
+    # this scrubs some sensitive info from the string content. for example:
+    #
+    # ```
+    # unexpected token at '{
+    # "role": "admin","password": "Abc@123","foo": "bar"
+    # }'
+    # ```
+    #
+    # will become
+    #
+    # ```
+    # unexpected token at '{
+    # "role": "admin","password": *******,"foo": "bar"
+    # }'
+    # ```
+    #
+    # it's particularly useful in hash or param-parsing related errors
+    def sanitize_sensitive_string_content(value)
+      value.gsub(/(#{sensitive_fields}['":]\s?(:|=>)?\s?)(".*?"|'.*?')/, '\1' + STRING_MASK)
+    end
+
     def matches_regexes?(k, v)
       (sanitize_credit_cards && v =~ CREDIT_CARD_RE) ||
-        k =~ fields_re
+        k =~ sensitive_fields
     end
 
-    def fields_re
-      return @fields_re if instance_variable_defined?(:@fields_re)
+    def sensitive_fields
+      return @sensitive_fields if instance_variable_defined?(:@sensitive_fields)
+
       fields = DEFAULT_FIELDS | sanitize_fields
       fields -= sanitize_fields_excluded
-      @fields_re = /#{fields.map do |f|
+      @sensitive_fields = /#{fields.map do |f|
         use_boundary?(f) ? "\\b#{f}\\b" : f
       end.join("|")}/i
     end
@@ -80,6 +127,7 @@ module Raven
 
     def parse_json_or_nil(string)
       return unless string.start_with?(*JSON_STARTS_WITH)
+
       JSON.parse(string)
     rescue JSON::ParserError, NoMethodError
       nil

data/lib/raven/processor/utf8conversion.rb

@@ -14,6 +14,7 @@ module Raven
         !value.frozen? ? value.map! { |v| process v } : value.map { |v| process v }
       when Exception
         return value if value.message.valid_encoding?
+
         clean_exc = value.class.new(remove_invalid_bytes(value.message))
         clean_exc.set_backtrace(value.backtrace)
         clean_exc
@@ -27,6 +28,7 @@ module Raven
           value.force_encoding(Encoding::UTF_8)
         end
         return value if value.valid_encoding?
+
         remove_invalid_bytes(value)
       else
         value

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]
@@ -26,10 +25,10 @@ module Raven
           req.headers['X-Sentry-Auth'] = auth_header
           req.body = data
         end
-      rescue Faraday::Error => ex
-        error_info = ex.message
-        if ex.response && ex.response[:headers]['x-sentry-error']
-          error_info += " Error in headers is: #{ex.response[:headers]['x-sentry-error']}"
+      rescue Faraday::Error => e
+        error_info = e.message
+        if e.response && e.response[:headers]['x-sentry-error']
+          error_info += " Error in headers is: #{e.response[:headers]['x-sentry-error']}"
         end
         raise Raven::Error, error_info
       end
@@ -42,7 +41,7 @@ module Raven
         proxy = configuration.public_send(:proxy)
 
         Faraday.new(configuration.server, :ssl => ssl_configuration, :proxy => proxy) do |builder|
-          configuration.faraday_builder.call(builder) if configuration.faraday_builder
+          configuration.faraday_builder&.call(builder)
           builder.response :raise_error
           builder.options.merge! faraday_opts
           builder.headers[:user_agent] = "sentry-ruby/#{Raven::VERSION}"

data/lib/raven/transports.rb

@@ -13,3 +13,7 @@ module Raven
     end
   end
 end
+
+require "raven/transports/dummy"
+require "raven/transports/http"
+require "raven/transports/stdout"

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/exception_cause_chain.rb

@@ -7,6 +7,7 @@ module Raven
           while exception.cause
             exception = exception.cause
             break if exceptions.any? { |e| e.object_id == exception.object_id }
+
             exceptions << exception
           end
           exceptions

data/lib/raven/utils/real_ip.rb

@@ -13,7 +13,7 @@ module Raven
         "fc00::/7",       # private IPv6 range fc00::/7
         "10.0.0.0/8",     # private IPv4 range 10.x.x.x
         "172.16.0.0/12",  # private IPv4 range 172.16.0.0 .. 172.31.255.255
-        "192.168.0.0/16", # private IPv4 range 192.168.x.x
+        "192.168.0.0/16" # private IPv4 range 192.168.x.x
       ].map { |proxy| IPAddr.new(proxy) }
 
       attr_accessor :ip, :ip_addresses

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
-  # Freezing this constant breaks in 1.9.x
-  VERSION = "2.13.0" # rubocop:disable Style/MutableConstant
+  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

@@ -11,11 +11,18 @@ Gem::Specification.new do |gem|
 
   gem.version = Raven::VERSION
   gem.platform = Gem::Platform::RUBY
-  gem.required_ruby_version = '>= 1.9.0'
+  gem.required_ruby_version = '>= 2.3'
   gem.extra_rdoc_files = ["README.md", "LICENSE"]
   gem.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples)'`.split("\n")
   gem.bindir = "exe"
   gem.executables = "raven"
 
-  gem.add_dependency "faraday", ">= 0.7.6", "< 1.0"
+  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,23 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 2.13.0
+  version: 3.1.2
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-17 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.6
-    - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
@@ -25,9 +22,6 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.6
-    - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
 description: A gem that provides a client interface for the Sentry error logger
@@ -39,34 +33,37 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
-- ".gitignore"
-- ".gitmodules"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
+- ".craft.yml"
+- ".scripts/bump-version.rb"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
-- changelog.md
 - exe/raven
 - lib/raven.rb
 - 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
 - lib/raven/context.rb
+- 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
@@ -114,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.0
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.gitignore

@@ -1,13 +0,0 @@
-coverage
-pkg
-ruby/
-log/
-.bundle
-*.gem
-gemfiles/*.lock
-Gemfile.lock
-.coveralls.yml
-.ruby-version
-.ruby-gemset
-.idea
-*.rdb

data/.rspec

@@ -1 +0,0 @@
---colour

data/.rubocop.yml

@@ -1,74 +0,0 @@
-AllCops:
-   Include:
-     - 'lib/**/*.rb'
-     - 'spec/**/*.rb'
-   Exclude:
-     - 'examples/**/*'
-     - 'vendor/**/*'
-
-Metrics/ClassLength:
-  Max: 300
-  CountComments: false
-
-Metrics/AbcSize:
-  Max: 40
-
-Metrics/CyclomaticComplexity:
-  Max: 12
-
-Metrics/PerceivedComplexity:
-  Max: 11
-
-Metrics/LineLength:
-  Max: 155
-
-Metrics/MethodLength:
-  Max: 30
-
-Style/SignalException:
-  Enabled: false
-
-Performance/Casecmp:
-  Enabled: false
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/ParallelAssignment:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/RescueModifier:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: false
-
-Style/CaseEquality:
-  Enabled: false
-
-Style/DoubleNegation:
-  Enabled: false
-
-Style/FileName:
-  Exclude:
-    - 'lib/sentry-raven-without-integrations.rb'
-    - 'lib/sentry-raven.rb'
-
-Style/NumericLiterals:
-  Exclude:
-    - 'spec/raven/processors/sanitizedata_processor_spec.rb'
-
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
-
-Lint/RescueException:
-  Exclude:
-    - 'lib/raven/base.rb'
-    - 'lib/raven/instance.rb'
-    - 'lib/raven/integrations/delayed_job.rb'
-    - 'lib/raven/integrations/rack.rb'
-    - 'lib/raven/integrations/sidekiq.rb'
-    - 'spec/raven/event_spec.rb'

data/.travis.yml

@@ -1,47 +0,0 @@
-language: ruby
-dist: trusty
-group: beta
-cache: bundler
-
-services:
-  - redis-server
-
-branches:
-  only: [master]
-
-rvm:
-  - 2.2.10
-  - 2.3.8
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
-
-env:
-  - RAILS_VERSION=4
-  - RAILS_VERSION=5
-  - RAILS_VERSION=0
-
-addons:
-  apt:
-    packages:
-      - haveged
-
-before_install:
-  - service haveged start
-  # Pin bundler version due to https://github.com/rubygems/rubygems/issues/2055
-  - gem install bundler -v 1.16.0
-
-matrix:
-  include:
-    - rvm: 1.9
-      env: RAILS_VERSION=4
-    - rvm: jruby-1.7.27
-      env: JRUBY_OPTS="--dev" RAILS_VERSION=4
-    - rvm: jruby-9.2.9.0
-      env: JRUBY_OPTS="--dev -J-Djruby.launch.inproc=true -J-Xmx1024M" RAILS_VERSION=4
-    - rvm: jruby-9.2.9.0
-      env: JRUBY_OPTS="--dev -J-Djruby.launch.inproc=true -J-Xmx1024M" RAILS_VERSION=5
-    - rvm: ruby-head
-      env: RAILS_VERSION=0
-  allow_failures:
-    - rvm: ruby-head